From 33cc9742cb3d1a6a14b12f5c930622865de7551f Mon Sep 17 00:00:00 2001 From: jahway603 Date: Sat, 28 Nov 2020 03:05:42 -0500 Subject: [PATCH] initial git.hush.is Hush-docs commit --- README.md | 50 +++++++++++++++++ hushd-desktop-linux.md | 116 +++++++++++++++++++++++++++++++++++++++ hushd-desktop-windows.md | 41 ++++++++++++++ sd.md | 18 ++++++ sdl.md | 15 +++++ 5 files changed, 240 insertions(+) create mode 100644 README.md create mode 100644 hushd-desktop-linux.md create mode 100644 hushd-desktop-windows.md create mode 100644 sd.md create mode 100644 sdl.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9115d25 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# Hush Docs + +

+ + MyHushTeam's Twitter + + follow on Twitter + + follow on Mastodon + + MyHushTeam's Reddit + + MyHushTeam's Telegram +

+ +## Hush Documentation + +Most people visiting this page will be seeking how to setup their wallets. We also have a section for those interested in running servers. + +### Wallets + +If you are looking to setup a Hush wallet, then you have the following two choices dependant upon your requirements: + +- [Setup Hush full node with hushd](sd.md) +- [Setup Hush lite wallet featuring Hushchat](sdl.md) + +As for mobile wallets: +- Hush Android app is a companion app which pairs with either of the above two options. +- Hush does not have an iOS app yet, care to make one? + +#### Servers? + +If you know what you're doing, and want to setup a server to help the Hush community, then the following documents are for you: + +- [Setup your own Hush Lite Wallet Server](hush-lite-server.md) (**Work in progress**) +- [Setup your own Hush Wormhole Server](wormhole.md) (**Work in progress**) + +## Support Links + +- [Hush general Telegram chat](https://t.me/Hush_Coin) +- [Hush tech support via Telegram](https://t.me/hush8support) + +## How to follow Hush + +- [Twitter](https://twitter.com/MyHushTeam) +- [Telegram](https://t.me/Hush_Coin) diff --git a/hushd-desktop-linux.md b/hushd-desktop-linux.md new file mode 100644 index 0000000..f51e3b9 --- /dev/null +++ b/hushd-desktop-linux.md @@ -0,0 +1,116 @@ +# Setup Hush full node with hushd on Linux + +In this example, we are using Ubuntu 18.04 (64 bits). This will be different on Mac and Windows, so refer to those OS's docs. + +## Setup hushd + +### Setup hush user account + +1) Log in as user account with sudo access and add a user 'hush' under which the daemon (hushd) will run : + + ``` + $ sudo useradd -r -m -s /bin/bash -d /home/hush hush + ``` + +2) Assign a password to the 'hush' user and add to sudo group: + + ``` + $ sudo passwd hush + $ sudo adduser hush sudo + ``` + +3) Switch to user 'hush' +su - hush + +4) Update your system + + ``` + $ sudo apt-get update + $ sudo apt-get upgrade -y + ``` + +### Hush binary or compile yourself? + +The next step is up to you. I personally like to compile from source and recommend trying that if you experience any issues. + +#### binary OR... + +If you just want to install an "exe" file, run it, and go, then I would recommend trying the binary install. + +On Ubuntu 18.04/20.04 (Debian?), try this: +$ wget https://github.com/MyHush/hush3/releases/download/v3.5.2/hush-3.5.2-amd64.deb +$ sudo dpkg -i hush-3.5.2-amd64.deb + +#### compile yourself + +The choice is up to you, but if the binary does not work then try compiling it yourself. + +For Ubuntu 18.04 or 20.04, use the following: + + ``` + # Install build depedencies + $ sudo apt-get install build-essential pkg-config libc6-dev m4 g++-multilib autoconf libtool ncurses-dev unzip git python zlib1g-dev wget bsdmainutils automake curl unzip nano libsodium-dev + + # Pull + $ git clone https://git.hush.is/hush/hush3.git + $ cd hush3 + + # Build + $./build.sh -j$(nproc) replace $(nproc) by the number of processor (example : 4) + ``` + +For Arch Linux, there are [hush3](https://aur.archlinux.org/packages/hush3/) and [hush3-bin](https://aur.archlinux.org/packages/hush3-bin/) AUR packages available. If you'd rather compile yourself, then use the following: + + ``` + # Install build depedencies + $ sudo pacman -S libsodium lib32-zlib unzip wget git python rust curl + + # Pull + $ git clone https://git.hush.is/hush/hush3.git + $ cd hush3 + + # Build + $./build.sh -j$(nproc) replace $(nproc) by the number of processor (example : 4) + ``` + +### Setup HUSH3.conf + +1) The data (blockchain, configuration, etc.) will be stored in '/home/.komodo/HUSH3' (on Linux) by default. + + ``` + $ mkdir -p ~/.komodo/HUSH3 + ``` +1) Open the configuration file in your favorite text editor (nano, vim, etc). I would change the values below with CHANGETHIS appended and you can change the rpcport if you'd like: + + ``` + rpcuser=user-CHANGETHIS + rpcpassword=pass-CHANGETHIS + rpcport=18031 + server=1 + daemon=1 + txindex=1 + rpcworkqueue=256 + rpcallowip=127.0.0.1 + rpcbind=127.0.0.1 + + addressindex=1 + spentindex=1 + timestampindex=1 + + showmetrics=1 + + addnode=explorer.myhush.org + addnode=stilgar.leto.net + addnode=dnsseed.bleuzero.com + addnode=dnsseed.hush.quebec + ``` + +### Now we can start hushd daemon + +Run this and it will take some time to sync with the network. + + ``` + $ which hushd # then run from where it's installed + $ hushd + ``` + diff --git a/hushd-desktop-windows.md b/hushd-desktop-windows.md new file mode 100644 index 0000000..b23104f --- /dev/null +++ b/hushd-desktop-windows.md @@ -0,0 +1,41 @@ +# Setup Hush full node with hushd on Windows + +In this example, we are using Windows 10 (64 bit). + +## Setup hushd + +### Hush binary or compile yourself? + +On Windows I suggest you use the release binary unless you know what you're doing regarding code and compilers. + +1) Download the [release binary here](https://github.com/MyHush/hush3/releases/) and unextract the zip file. + +1) The data (blockchain, configuration, etc.) will be stored in 'C:\Users\/AppData/Roaming/Komodo/HUSH3' (on Windows) by default. + +1) Open the configuration file in your favorite text editor. I would change the values below with CHANGETHIS appended and you can change the rpcport if you'd like: + + ``` + rpcuser=user-CHANGETHIS + rpcpassword=pass-CHANGETHIS + rpcport=18031 + server=1 + daemon=1 + txindex=1 + rpcworkqueue=256 + rpcallowip=127.0.0.1 + rpcbind=127.0.0.1 + + addnode=explorer.myhush.org + addnode=stilgar.leto.net + addnode=dnsseed.bleuzero.com + addnode=dnsseed.hush.quebec + ``` + +### Now we can start hushd daemon + +1) Open the directory you extracted to in a command prompt window. I use cmd on Windows, but some user PowerShell. + +1) Run hushd.bat and a **Windows Security Alert should immediately pop-up** regarding "komodod". + +1) We want this, so we check the two checkboxes and Accept. This will take some time to sync and you will see a bunch go across the screen. Congratulations as now you have Hushd running on your Windows system! + diff --git a/sd.md b/sd.md new file mode 100644 index 0000000..5517805 --- /dev/null +++ b/sd.md @@ -0,0 +1,18 @@ +# Silent Dragon + +This documentation is how you setup Silent Dragon, which is the Hush full node wallet. + +## 1) Setup hushd + +First you want to setup the Hush daemon (hushd). This enables your computer to download the complete Hush blockchain. + +- If you have Linux, [click here](hushd-desktop-linux.md) +- If you have Windows, [click here](hushd-desktop-windows.md) +- If you have Mac, <_please contribute_> + +## 2) Install Silent Dragon + +**Make sure you make a paper backup of your seed phrases!** + +Pick either the [binary release](https://github.com/MyHush/SilentDragon/releases) or [compile it yourself](https://git.hush.is/hush/SilentDragon/blob/master/README.md). I personally compile but some prefer binaries. + diff --git a/sdl.md b/sdl.md new file mode 100644 index 0000000..583d050 --- /dev/null +++ b/sdl.md @@ -0,0 +1,15 @@ +# Silent Dragon Lite + +This documentation is how you setup Silent Dragon Lite (SDL), which is the Hush lite wallet featuring HushChat. + +## Download and install SDL + +**Make sure you make a paper backup of your seed phrases!** + +- For Binary releases, [the download link is here](https://github.com/MyHush/SilentDragonLite/releases) +- For source code so you can compile your own, [the link is here](https://git.hush.is/hush/SilentDragonLite) + +## After you install + +- If it is having trouble connecting, then please go into the [Hush Tech Support Telegram channel](https://t.me/hush8support) +