Novacoin: add scrypt module source, update documentation
[electrum-server.git] / HOWTO.md
index 53d2088..3e7755f 100644 (file)
--- a/HOWTO.md
+++ b/HOWTO.md
@@ -12,7 +12,7 @@ requirements.
 
 The most up-to date version of this document is available at:
 
-    https://github.com/spesmilo/electrum-server/blob/master/HOWTO.md
+    https://github.com/CryptoManiac/electrum-server/blob/master/HOWTO.md
 
 Conventions
 -----------
@@ -20,8 +20,8 @@ Conventions
 In this document, lines starting with a hash sign (#) or a dollar sign ($)
 contain commands. Commands starting with a hash should be run as root,
 commands starting with a dollar should be run as a normal user (in this
-document, we assume that user is called 'bitcoin'). We also assume the
-bitcoin user has sudo rights, so we use '$ sudo command' when we need to.
+document, we assume that user is called 'novacoin'). We also assume the
+novacoin user has sudo rights, so we use '$ sudo command' when we need to.
 
 Strings that are surrounded by "lower than" and "greater than" ( < and > )
 should be replaced by the user with something appropriate. For example,
@@ -53,10 +53,10 @@ build chain. You will need root access in order to install other software or
 Python libraries. 
 
 **Hardware.** The lightest setup is a pruning server with diskspace 
-requirements of about 10 GB for the electrum database. However note that 
-you also need to run bitcoind and keep a copy of the full blockchain, 
-which is roughly 20 GB in April 2014. If you have less than 2 GB of RAM 
-make sure you limit bitcoind to 8 concurrent connections. If you have more 
+requirements of about 200 MB for the electrum database. However note that 
+you also need to run novacoind and keep a copy of the full blockchain, 
+which is roughly 100 MB in 20 July 2014. If you have less than 2 GB of RAM 
+make sure you limit novacoind to 16 concurrent connections. If you have more 
 ressources to  spare you can run the server with a higher limit of historic 
 transactions per address. CPU speed is important, mostly for the initial block 
 chain import, but also if you plan to run a public Electrum server, which 
@@ -67,21 +67,21 @@ has enough RAM to hold and procss the leveldb database in tmpfs (e.g. /dev/shm).
 Instructions
 ------------
 
-### Step 1. Create a user for running bitcoind and Electrum server
+### Step 1. Create a user for running novacoind and Electrum server
 
 This step is optional, but for better security and resource separation I
-suggest you create a separate user just for running `bitcoind` and Electrum.
+suggest you create a separate user just for running `novacoind` and Electrum.
 We will also use the `~/bin` directory to keep locally installed files
 (others might want to use `/usr/local/bin` instead). We will download source
 code files to the `~/src` directory.
 
-    $ sudo adduser bitcoin --disabled-password
+    $ sudo adduser novacoin --disabled-password
     $ sudo apt-get install git
-    # su - bitcoin
+    # su - novacoin
     $ mkdir ~/bin ~/src
     $ echo $PATH
 
-If you don't see `/home/bitcoin/bin` in the output, you should add this line
+If you don't see `/home/novacoin/bin` in the output, you should add this line
 to your `.bashrc`, `.profile` or `.bash_profile`, then logout and relogin:
 
     PATH="$HOME/bin:$PATH"
@@ -92,65 +92,48 @@ We will download the latest git snapshot for Electrum and 'install' it in
 our ~/bin directory:
 
     $ mkdir -p ~/electrum-server
-    $ git clone https://github.com/spesmilo/electrum-server.git
-
-### Step 3. Download bitcoind
-
-Older versions of Electrum used to require a patched version of bitcoind. 
-This is not the case anymore since bitcoind supports the 'txindex' option.
-We currently recommend bitcoind 0.9.2 stable.
-
-If your package manager does not supply a recent bitcoind and prefer to compile
-here are some pointers for Ubuntu:
-
-    # apt-get install make g++ python-leveldb libboost-all-dev libssl-dev libdb++-dev pkg-config
-    # su - bitcoin
-    $ cd ~/src && wget https://bitcoin.org/bin/0.9.2/bitcoin-0.9.2-linux.tar.gz
-    $ sha256sum bitcoin-0.9.2-linux.tar.gz | grep 58a77aeb4c81b54d3903d85abce4f0fb580694a3611a415c5fe69a27dea5935b
-    $ tar xfz bitcoin-0.9.2-linux.tar.gz
-    $ cd bitcoin-0.9.2-linux/src
-    $ tar xfz bitcoin-0.9.2.tar.gz
-    $ cd bitcoin-0.9.2
-    $ ./configure --disable-wallet --without-miniupnpc
-    $ make
-    $ strip ~/src/bitcoin-0.9.2-linux/src/bitcoin-0.9.2/src/bitcoind
-    $ cp -a ~/src/bitcoin-0.9.2-linux/src/bitcoin-0.9.2/src/bitcoind ~/bin/bitcoind
-
-### Step 4. Configure and start bitcoind
-
-In order to allow Electrum to "talk" to `bitcoind`, we need to set up a RPC
-username and password for `bitcoind`. We will then start `bitcoind` and
+    $ git clone https://github.com/CryptoManiac/electrum-server.git
+    $ cd electrum-server/ltc-scrypt
+    $ sudo python setup.py install
+
+### Step 3. Download novacoind
+
+    # apt-get install make g++ python-leveldb libboost-all-dev libssl-dev libdb++-dev pkg-config libminiupnpc-dev git
+    # su - novacoin
+    $ cd ~/src && git clone https://github.com/nova-project/novacoin.git
+    $ cd novacoin/src
+    $ make -f makefile.unix
+    $ strip novacoind
+    $ cp -a ~/src/litecoin/src/litecoind ~/bin/litecoind
+
+### Step 4. Configure and start novacoind
+
+In order to allow Electrum to "talk" to `novacoind`, we need to set up a RPC
+username and password for `novacoind`. We will then start `novacoind` and
 wait for it to complete downloading the blockchain.
 
-    $ mkdir ~/.bitcoin
-    $ $EDITOR ~/.bitcoin/bitcoin.conf
+    $ mkdir ~/.novacoin
+    $ $EDITOR ~/.novacoin/novacoin.conf
 
-Write this in `bitcoin.conf`:
+Write this in `novacoin.conf`:
 
     rpcuser=<rpc-username>
     rpcpassword=<rpc-password>
     daemon=1
-    txindex=1
-
 
-If you have an existing installation of bitcoind and have not previously
-set txindex=1 you need to reindex the blockchain by running
+If you have a fresh copy of novacoind start `novacoind`:
 
-    $ bitcoind -reindex
+    $ novacoind
 
-If you have a fresh copy of bitcoind start `bitcoind`:
-
-    $ bitcoind
-
-Allow some time to pass, so `bitcoind` connects to the network and starts
+Allow some time to pass, so `novacoind` connects to the network and starts
 downloading blocks. You can check its progress by running:
 
-    $ bitcoind getinfo
+    $ novacoind getinfo
 
-Before starting electrum server your bitcoind should have processed all 
+Before starting electrum server your novacoind should have processed all 
 blockes and caught up to the current height of the network.
-You should also set up your system to automatically start bitcoind at boot
-time, running as the 'bitcoin' user. Check your system documentation to
+You should also set up your system to automatically start novacoind at boot
+time, running as the 'novacoin' user. Check your system documentation to
 find out the best way to do this.
 
 ### Step 5. Install Electrum dependencies
@@ -266,7 +249,7 @@ in case you need to restore it.
 ### Step 10. Configure Electrum server
 
 Electrum reads a config file (/etc/electrum.conf) when starting up. This
-file includes the database setup, bitcoind RPC setup, and a few other
+file includes the database setup, novacoind RPC setup, and a few other
 options.
 
     $ sudo cp ~/src/electrum/server/electrum.conf.sample /etc/electrum.conf
@@ -284,7 +267,7 @@ root user who usually passes this value to all unprivileged user sessions too.
 
     $ sudo sed -i '$a ulimit -n 16384' /root/.bashrc
 
-Also make sure the bitcoin user can actually increase the ulimit by allowing it accordingly in
+Also make sure the novacoin user can actually increase the ulimit by allowing it accordingly in
 /etc/security/limits.conf
 
 While most bugs are fixed in this regard electrum server may leak some memory and it's good practice to
@@ -293,9 +276,9 @@ it for crashes and then restart the server. Monthly restarts should be fine for
 
 Two more things for you to consider:
 
-1. To increase security you may want to close bitcoind for incoming connections and connect outbound only
+1. To increase security you may want to close novacoind for incoming connections and connect outbound only
 
-2. Consider restarting bitcoind (together with electrum-server) on a weekly basis to clear out unconfirmed
+2. Consider restarting novacoind (together with electrum-server) on a weekly basis to clear out unconfirmed
    transactions from the local the memory pool which did not propagate over the network
 
 ### Step 12. (Finally!) Run Electrum server
@@ -326,16 +309,4 @@ or hostname and the port. Press Ok, the client will disconnect from the
 current server and connect to your new Electrum server. You should see your
 addresses and transactions history. You can see the number of blocks and
 response time in the Server selection window. You should send/receive some
-bitcoins to confirm that everything is working properly.
-
-### Step 14. Join us on IRC, subscribe to the server thread
-
-Say hi to the dev crew, other server operators and fans on 
-irc.freenode.net #electrum and we'll try to congratulate you
-on supporting the community by running an Electrum node
-
-If you're operating a public Electrum server please subscribe
-to or regulary check the following thread:
-https://bitcointalk.org/index.php?topic=85475.0
-It'll contain announcements about important updates to Electrum
-server required for a smooth user experience.
+novacoins to confirm that everything is working properly.