lthn/mining-pool
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updating the documentation to fix <>'s

Browse source
This commit is contained in:
Alexander Blair 2017-02-10 22:28:13 -08:00
parent 36ccea6825
commit ea2c46dacd
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,3 +1,33 @@
Pool Design/Theory
==================
The nodejs-pool is built around a small series of core daemons that share access to a single LMDB table for tracking of shares, with MySQL being used to centralize configurations and ensure simple access from local/remote nodes. The core daemons follow:
```text
api - Main API for the frontend to use and pull data from. Expects to be hosted at /
remoteShare - Main API for consuming shares from remote/local pools. Expects to be hosted at /leafApi
pool - Where the miners connect to.
longRunner - Database share cleanup.
payments - Handles all payments to workers.
blockManager - Unlocks blocks and distributes payments into MySQL
worker - Does regular processing of statistics and sends status e-mails for non-active miners.
```
API listens on port 8001, remoteShare listens on 8000
Xmrpool.net (The refrence implementation) uses the following setup:
https://xmrpool.net is hosted on it's own server, as the main website is a static frontend
https://api.xmrpool.net hosts api, remoteShare, longRunner, payments, blockManager, worker, as these must all be hosted with access to the same LMDB database.
Sample Caddyfile for API:
```text
https://api.xmrpool.net {
proxy /leafApi 127.0.0.1:8000
proxy / 127.0.0.1:8001
cors
gzip
}
```
It is critically important that your webserver does not truncate the /leafApi portion of the URL for the remoteShare daemon, or it will not function! Local pool servers DO use the remoteShare daemon, as this provides a buffer in case of an error with LMDB or another bug within the system, allowing shares and blocks to queue for submission as soon as the leafApi/remoteShare daemons are back up and responding with 200's.
Setup Instructions
==================