Create Testnet.md

Instructions for running a Testnet

Testnet.md

@@ -0,0 +1,107 @@
+HUSH 1.0.9 - Testnet
+=============
+
+What is a Testnet?
+--------------
+
+![Logo](doc/hush/hush.png "Logo")
+
+This software is the HUSH node and command-line Testnet client. It provides
+a safe place - off the main network - for testing of new features,
+applications and ideas without compromising the security of the main network.
+
+How is running the Testnet different to running a Mainnet node?
+--------------
+
+In essence their is very little difference in running a Testnet to a Mainnet node
+it only requires one of two possible changes in how you start the node.
+
+However - it is important that before you choose which method to use, you consider
+if you will be ONLY running a Testnet node, or if you will be running one alongside
+a Mainnet node on the same computer.
+
+### To run a Testnet node on it's own (the simplest way) once only.
+Make sure there are no other instances of Hush running:
+```
+cd hush
+./src/hush-cli stop
+```
+Start the Testnet:
+```
+./src/hushd -testnet
+```
+### To run a Testnet node on it's own every time Hush is started.
+For this we need to edit the hush.conf configuration file.
+
+Using your favourite text editor add the following line to the hush.conf file:
+```
+testnet=1
+```
+
+### What if I want to run Mainnet and Testnet at the same time?
+This is slightly more complex - as you will need to tell the client (hush-cli) which
+node you want to talk to when you ask it questions.
+
+By default hush-cli will talk to the Mainnet node if one / both are running
+By default hush-cli will talk to the Testnet node if ONLY the testnet is running
+
+We need a way to tell hush-cli to talk to the Testnet node instead of the Mainnet
+node if both are running.
+We can do this by calling the correct Testnet RPC port on the command line:
+```
+hush-cli -rpcport=18822 getinfo
+```
+this should show the Testnet node details and Testnet should be listed.
+
+Building
+--------
+Building a Testnet node is no different from building a mainnet node - it
+is built into the mainnet node software, which builds as follows:
+
+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.
+Build HUSH along with most dependencies from source by running
+Get dependencies:
+```{r, engine='bash'}
+
+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
+```
+
+Create a HUSH configuration file (*important*):
+```
+mkdir -p ~/.hush
+echo "rpcuser=username" >> ~/.hush/hush.conf
+echo "rpcpassword=`head -c 32 /dev/urandom | base64`" >>~/.hush/hush.conf
+```
+
+Install HUSH
+```{r, engine='bash'}
+# pull
+git clone https://github.com/MyHush/hush.git
+cd hush
+# fetch key
+./zcutil/fetch-params.sh
+# Build
+./zcutil/build.sh -j$(nproc)
+# Run a HUSH node
+./src/hushd
+```
+
+Currently only Linux is officially supported. Windows/Mac OS X versions are in the works...
+
+Deprecation Policy
+------------------
+
+This release is considered deprecated 16 weeks after the release day. There
+is an automatic deprecation shutdown feature which will halt the node some
+time after this 16 week time period. The automatic feature is based on block
+height and can be explicitly disabled.
+
+License
+-------
+
+For license information see the file [COPYING](COPYING).