readem

README.md

@@ -1,23 +1,26 @@
-## Mining stratum for Komodo and Komodo assetchains.
+# Mining stratum for Komodo and Komodo assetchains.
 
-Requirements
-------------
+## Requirements
 * node v10+
 * libsodium
 * boost
 * Redis (see https://redis.io/topics/quickstart for details)
 
-Differences between this and Z-NOMP
-------------
+## Differences between this and Z-NOMP
 * This is meant for Komodo mining
 * Founders, Treasury, and other ZEC/ZEN specific stuff is removed
 
-Using Docker (easy)
--------------
+## Using Docker (easy)
+
+This method sets up 2 docker containers, one with knomp and one with redis. 
+
+It will directly use your host system's network so you can connect to the coin daemon without opening up RPC beyond 127.0.0.1.
+
+The ports it listens on must not be in use, this includes 8080 for the website, 6379 for redis and any ports you open for stratums (default is 3333).
 
 [Install Docker](https://docs.docker.com/engine/install/)
 
-To install:
+### Docker Install
 ```
 git clone https://github.com/webworker01/knomp.git
 cd ./knomp
@@ -30,12 +33,12 @@ Setup your (config.json)[config_example.json], `./coins/` and `./pool_configs/`
 docker-compose up &
 ```
 
-To stop: 
+### Docker stop
 ```
 docker-compose down
 ```
 
-To rebuild:
+### Docker rebuild and update
 ```
 docker-compose down
 docker rmi knomp_knomp
@@ -43,8 +46,8 @@ git pull
 docker-compose up &
 ```
 
-Upgrade
--------------
+## Bare metal installation
+### Upgrade
 Please be sure to backup your `./coins` and `./pool_configs` directory before upgrading
 
 Kill your running pool (CTRL-C)
@@ -55,8 +58,7 @@ npm install
 npm start
 ```
 
-Install Daemon
--------------
+### Install Daemon
 Some initial setup
 ```shell
 # The following packages are needed to build both Komodo and this stratum:
@@ -81,8 +83,7 @@ cd ~/komodo/src
 ./assetchains
 ```
 
-Install Pool
--------------
+### Install Pool
 Once all the chains you want on your pool have synced up we can configure the stratum.
 
 We need node and npm installed
@@ -115,16 +116,15 @@ npm start
 
 If all went well the program should start without error and you should be able to browse to your pool website on your server via port 8080.
 
-Disable Coinbase Mode 
--------------
+## More Config Information
+### Disable Coinbase Mode 
 This mode uses -pubkey to tell the daemon where the coinbase should be sent, and uses the daemons coinbase transaction rather then having the pool create the coinabse transaction. This enables special coinbase transactions, such as ac_founders and ac_script or new modes with CC vouts in the coinbase not yet created, it will work with all coins, except Full Z support described below. 
 
 To enable it, change the value in the `./coins/*.json` to `"disablecb" : true`
 
 The pool fee is taken in the payment processor using this mode, and might not be 100% accurate down to the single satoshi, so the pool address may end up with some small amount of coins over time.
 
-Payment Processing
--------------
+### Payment Processing
 Please note that the default configs generated are for solo mining. If you wish to create a public pool please modify the configs like in this [example config](https://github.com/z-classic/z-nomp/blob/master/pool_configs/komodo_example.json)
 
 There is now a config option you can add to your pool_configs/coin.json to toggle making an attempt at a payment upon pool startup.
@@ -136,15 +136,13 @@ There is now a config option you can add to your pool_configs/coin.json to toggl
 }
 ```
 
-Invalid Worker Addresses
--------------
+### Invalid Worker Addresses
 You can add an option to your pool_config to have any miners that mine with an invalid address (if they somehow get through) to pay out to an address of your choosing
 ```
 "invalidAddress":"zsValidAddressOfYourChoosingThatsNotThePoolZAddress"
 ```
 
-Full Z Transaction Support (Sprout)
--------------
+### Full Z Transaction Support (Sprout)
 This is an option to force miners to use a Z address as their username for payouts
 
 In your coins file add: 
@@ -153,8 +151,7 @@ In your coins file add:
 "burnFees": true
 ```
 
-Sapling and Sapling Payment Support
--------------
+### Sapling and Sapling Payment Support
 In coins/pirate.json file:
 ```
 "privateChain": true,
@@ -174,12 +171,10 @@ In pool_config:
     "maxBlocksPerPayment": 20,
 ```
 
-More Resources
--------------
+### More Resources
 [Further info on config](https://github.com/zone117x/node-open-mining-portal#2-configuration) and some [sample configs](https://github.com/z-classic/z-nomp)
 
-License
--------------
+## License
 Forked from ComputerGenie repo (deleted)
 
 Released under the GNU General Public License v2