Typo fix
[stratum-mining.git] / INSTALL
1 Installation Instructions
2 =========================
3
4 Step 0: Install novacoind
5         It MUST be a recent version of novacoind
6         Set it up and start it!
7         Downloading the blockchain can take some time!
8
9 Step 1: Install the stratum core
10         git pull https://github.com/slush0/stratum.git
11         sudo easy_install stratum
12           (or if using alternate python: sudo /usr/local/bin/easy_install stratum)
13
14 Step 2: Pull a copy of the miner
15         git pull https://github.com/CryptoManiac/stratum-mining.git
16
17 Step 3: Configure the Miner
18         cp conf/config_sample.py conf/config.py
19         make your changes to conf/config.py 
20         Make sure you set the values in BASIC SETTINGS! These are how to connect to novacoind 
21         and where your money goes! Please read comments carefully, this may be helpful.
22         
23 Step 4: Run the pool
24         twistd -ny launcher.tac -l -
25         OR - using alternate python
26         /usr/local/bin/twistd -ny launcher.tac -l -
27
28 You can now set the URL on your stratum proxy (or miner that supports stratum) to:
29 http://YOURHOSTNAME:3333
30
31 Novacoind blocknotify Setup
32 =========================
33 Although scary (for me), this is actually pretty easy.
34
35 Step 1: Set Admin Password
36         Ensure that you have set the ADMIN_PASSWORD_SHA256 parameter in conf/config.py
37         To make life easy you can run the generateAdminHash script to make the hash
38                 ./scripts/generateAdminHash.sh <password>
39
40 Step 2: Test It
41         Restart the pool if it's already running
42         run ./scripts/blocknotify.sh --password <password> --host localhost --port 3333
43         Ensure everything is ok.
44
45 Step 3: Run bitcoind with blocknotify
46         Stop bitcoind if it's already running
47         bitcoind stop
48         Wait till it ends
49         novacoind -blocknotify="/absolute/path/to/scripts/blocknotify.sh --password <password> --host localhost --port 3333"
50
51 Step 4: Adjust pool polling
52         Now you should be able to watch the pools debug messages for awhile and see the blocknotify come in
53         once you are sure it's working edit conf/config.py and set
54                 PREVHASH_REFRESH_INTERVAL = to the same value as MERKLE_REFRESH_INTERVAL
55         restart the pool
56
57
58 Problems????
59 =========================
60
61 Is your firewall off?
62 Is novacoind running?
63
64 TODO: are there other problems?
65