# Configuration notes

## Table of Contents
* [Setup Config](#setup-config)
* [Setup your coin file](#setup-your-coin-file)
* [Setup your pool config](#setup-your-pool-config)
* [Notes](#notes)
* [License](#license)

## Setup Config

1. Open your new [config.json](config_example.json) and edit the following:
1. Change `"forks": 1` to `"forks: auto`.
1. Change `"stratumHost": "stratum.hushpool.io"` to your server.

## Setup your coin file

1. Change directory to coins.
1. You will see [HUSH](coins/hush.json) there as an example.
1. I then recommend you change the "hush.json example by 
[reading and learning from this repo](https://github.com/zone117x/node-stratum-pool#module-usage) to configure your own coin's file.

## Next, setup your pool

1. Change directory to the pool_configs directory.
1. You will see the [hushsolo example](pool_configs/hushsolo.json) there, which you can use to start from.
1. If you want to setup more than a solo pool, then I suggest learning what each 
option does [from this link](https://github.com/zone117x/node-open-mining-portal)
 as well as [checking these config out](https://github.com/z-classic/z-nomp/tree/master/pool_configs) to do so.

## License

Released under the GNU General Public License v2
http://www.gnu.org/licenses/gpl-2.0.html