-
Notifications
You must be signed in to change notification settings - Fork 7
Quickstart: Hosting a Pool
This page will list the quickstart method to hosting a prosper-pool. It should be known if you intend to host a public pool, there is additional steps to ensuring your pool is secure. This guide only serves as a base and is not intended for all production systems.
The pool is intended to be run in a docker setup, and a docker-compose has been provided as a reference.
It is recommended to git clone the pool's source repository. This allows you to follow the tagged releases. If you intend to contribute source code to the pool, another document will explain how to do so.
git clone [email protected]:FactomWyomingEntity/prosper-pool.git
cd prosper-pool
The default configuration file is found at prosper-pool.toml.example. You should make a copy, and edit the copy.
echo "This copied file is ignored by the gitignore"
cp prosper-pool.toml.example prosper-pool.toml
Change settings as you see fit. You will need to change the data sources. The data sources can be read up on here. The pool uses the same style configuration, and prosper-pool datasources --config prosper-pool.toml can be used to review your sources.
The pool uses a docker-compose to run, however the default configuration is not likely ideal for all cases. It is strongly recommend to crate a docker-compose.override.yaml file to adjust the setting, or completely redefine the docker-compose settings. When using this docker-compose, you should always specify the service you intend to run, vs using the general docker-compose up. But just in case, you should also disable the original services in your override.
Copy the example docker-compose.override.yaml.example to docker-compose.override.yaml. Customize the services as you need, and you do not need to modify the original which will cause git conflicts in your clone.
cp docker-compose.override.yaml.example docker-compose.override.yaml
To launch the services, use:
docker-compose up --build -d my-db
docker-compose up --build -d my-prosper-pool
To connect a miner to your new pool, we need to create a new invite code. The document ADMIN.md will explain how, and here are the quick commands:
$ echo "Get into the pool's container"
$ docker exec -it prosper-pool /bin/bash
$ echo "Make an invite code"
$ /go/bin/prosper-pool --phost $DB db code
> New Code: 2RWv5EJVaBnivCAvcfbsuheZCm4d
Use the code 2RWv5EJVaBnivCAvcfbsuheZCm4d to connect your miner. You will need the miner binary, which you can find here.
With the miner binary, follow the initial miner documentation, using --poolhost localhost:1235.
E.g:
# pool-address username invitecode pass PayoutAddress
./prosper-miner -s localhost:1235 -u [email protected] -i 2RWv5EJVaBnivCAvcfbsuheZCm4d -p -a FA2jK2HcLnRdS94dEcU27rF3meoJfpUcZPSinpb7AwQvPRY6RL1Q
Your pool is now up! To see the pool's logs:
docker logs -f prosper-pool