diff --git a/README.md b/README.md index 214bb4a..7ec0b14 100644 --- a/README.md +++ b/README.md @@ -27,13 +27,17 @@ Most people visiting this page will be seeking how to setup their wallets. We al If you are looking to setup a Hush wallet, then you have the following two choices: -- [Setup Hush full node with hushd](sd.md) -- [Setup Hush lite wallet featuring Hushchat](sdl.md) +- [Setup Hush full node wallet with hushd](sd.md) +- [Setup Hush lite wallet featuring HushChat](sdl.md) As for mobile wallets: - [Hush Android app](sda.md) is a companion app which pairs with either of the above two options. A mobile lite wallet is in development. - Hush does not have an iOS app yet, care to make one? +### HushChat + +Currently [HushChat](https://git.hush.is/hush/hushchat) is only available in the Hush lite wallet and it is in beta mode. If you are interested in testing it, then [please refer to our guide](https://git.hush.is/hush/hushchat/src/branch/master/guide.md). + #### Miners @@ -58,7 +62,7 @@ If you know what you're doing, and want to setup a server to help the Hush commu If you need some Hush kung-fu, then you know what to do!!! This is not for regular users :) -- [SDL in the RAW](sdl-in-the-raw.md): this howto is to setup an SDL server locally if your system is unable to access any online +- [SDL in the RAW](advanced/sdl-in-the-raw.md): this howto is to setup an SDL server locally if your system is unable to access any online ## Support Links diff --git a/sdl-in-the-raw.md b/advanced/sdl-in-the-raw.md similarity index 100% rename from sdl-in-the-raw.md rename to advanced/sdl-in-the-raw.md diff --git a/hushd-desktop-linux.md b/hushd-desktop-linux.md index 74d8510..ecc2a30 100644 --- a/hushd-desktop-linux.md +++ b/hushd-desktop-linux.md @@ -1,38 +1,35 @@ # 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. +In this example, we are using Ubuntu 18.04 (64 bit). This will be different on Mac and Windows, so refer to those OS's docs. ## Setup hushd -### Setup hush user account +### Optional: Setup hush user account -I would consider this optional as you can run hushd as your own user account. Creating a separate user account is great for added security and recommended for servers. +This is optional as you can run hushd as your own user account. Creating a separate user account is great for added security and typically recommended for servers. 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 + ```shell script + 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 + ```shell script + 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 + ```shell script + 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. +The next step is up to you. I personally like to compile from source and recommend trying that first. #### binary OR... @@ -47,39 +44,26 @@ On Ubuntu 18.04/20.04 (Debian?), try this: 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: - + ```shell script + 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 + git clone https://git.hush.is/hush/hush3.git + cd hush3 + ./build.sh -j$(nproc) ``` - # 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) +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, but here is how to compile it yourself: + ```shell script + sudo pacman -S libsodium lib32-zlib unzip wget git python rust curl + git clone https://git.hush.is/hush/hush3.git + cd hush3 + ./build.sh -j$(nproc) ``` ### Setup HUSH3.conf 1) The data (blockchain, configuration, etc.) will be stored in '/home/.komodo/HUSH3' (on Linux) by default. - - ``` - $ mkdir -p ~/.komodo/HUSH3 + ```shell script + 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: @@ -99,10 +83,20 @@ For Arch Linux, there are [hush3](https://aur.archlinux.org/packages/hush3/) and ### Now we can start hushd daemon -Run this and it will take some time to sync with the network. +Last we run this and it will take some time to sync with the network. + +##### If you installed a binary + ```shell script + which hushd # then run from where it's installed + hushd ``` - $ which hushd # then run from where it's installed - $ hushd + +##### If you compiled + + ```shell script + # run from the src directory of where you compiled it + cd src + ./hushd ```