hush3/INSTALL.md

Installing Hush

Installing Binaries

To install a Debian package:

dpkg -i hush-3.5.0-amd4.deb

To uninstall:

apt-get remove hush

Build HUSH dependencies

The following build process generally applies to Ubuntu (and similar) Linux distributions. For best results it is recommended to use Ubuntu Linux 16.04 or later.

Swap Space (Optional)

You will need at least 4GB of RAM to build hush from git source, OR you can enable a swap file. To enable a 4GB swap file on modern Linux distributions:

sudo fallocate -l 4G /swapfile
sudo chmod 600 /swapfile
sudo mkswap /swapfile
sudo swapon /swapfile

Build on Linux:

# 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
cd hush3
# Build
./build.sh -j$(nproc)

Run a HUSH Node

./src/hushd

Windows (cross-compiled on Linux)

Get dependencies:

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 mingw-w64 cmake libsodium-dev

Downloading Git source repo, building and running Hush:

# pull
git clone https://git.hush.is/hush/hush3
cd hush
# Build
./build-win.sh -j$(nproc)
# Run a HUSH node
./src/hushd

Currently Linux, Windows and Mac OS X are our supported platforms. If you are interested in porting Hush to a new operating system, we are interested to talk with you. Experimental FreeBSD support is in progress, thanks to radix42.

We aim to support all platforms, but there is only so much time in the day.

Currently, any ARMv7 machine will not be able to build this repo, because the underlying tech (zcash and the zksnark library) do not support that instruction set.

This also means that RaspberryPi devices will not work, unless they have a newer ARMv8-based Raspberry Pi.