Hush Documentation for all levels of users
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

101 lines
3.0 KiB

# Setup Hush full node with hushd on Linux
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
### Optional: Setup hush user account
Most users will run hushd as their own user account and will not need to do this. If this is you then skip to the next section.
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 :
```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:
```shell script
sudo passwd hush
sudo adduser hush sudo
```
3) Switch to user 'hush': su - hush
4) Update your system
```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 I always recommend trying that first.
#### 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:
- go to [hush3 releases page](https://git.hush.is/hush/hush3/releases) and get latest version
- then install using ```dpkg -i hush-3.x.x-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:
```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)
```
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.
```shell script
mkdir -p ~/.komodo/HUSH3
```
1) Open the HUSH3.conf 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
txindex=1
rpcworkqueue=256
rpcallowip=127.0.0.1
rpcbind=127.0.0.1
```
### Now we can start hushd daemon
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
```
##### If you compiled
```shell script
# run from the src directory of where you compiled it
cd src
./hushd
```