From 699595ceeb871939c562182b4c851a60af9c3d35 Mon Sep 17 00:00:00 2001 From: Con Kolivas Date: Tue, 19 Aug 2014 17:26:18 +1000 Subject: [PATCH] Document configuration --- README | 42 ++++++++++++++++++++++++++++++++++++++++++ ckpool.conf | 3 ++- ckproxy.conf | 3 ++- 3 files changed, 46 insertions(+), 2 deletions(-) diff --git a/README b/README index 6f273ce1..425e4c2e 100644 --- a/README +++ b/README @@ -172,3 +172,45 @@ talk to. -s tells ckpool which directory to place its own communication sockets (/tmp by default) + + +--- +CONFIGURATION + +At least one bitcoind is mandatory in ckpool mode with the minimum requirements +of server, rpcuser and rpcpassword set. + +Ckpool takes a json encoded configuration file in ckpool.conf by default or +ckproxy.conf in proxy or passthrough mode unless specified with -c. Sample +configurations for ckpool and ckproxy are included with the source. Entries +after the valid json are ignored and the space there can be used for comments. +The options recognised are as follows: + + +"btcd" : This is an array of bitcoind(s) with the options url, auth and pass +which match the configured bitcoind. This is mandatory in pool mode. + +"proxy" : This is an array in the same format as btcd above but is used in +proxy and passthrough mode to set the upstream pool and is mandatory. + +"btcaddress" : This is the bitcoin address to try to generate blocks to. + +"btcsig" : This is an optional signature to put into the coinbase of mined +blocks. + +"blockpoll" : This is the frequency in milliseconds for how often to check for +new network blocks and is 500 by default. + +"update_interval" : This is the frequency that stratum updates are sent out to +miners and is set to 30 seconds by default to help perpetuate transactions for +the health of the bitcoin network. + +"serverurl" : This is the IP to try to bind ckpool uniquely to, otherwise it +will attempt to bind to all interfaces in port 3333 by default in pool mode +and 3334 in proxy mode. + +"mindiff" : Minimum diff that vardiff will allow miners to drop to. Default 1 + +"startdiff" : Starting diff that new clients are given. Default 42 + +"logdir" : Which directory to store pool and client logs. Default "logs" diff --git a/ckpool.conf b/ckpool.conf index fcd1d7bb..ed823703 100644 --- a/ckpool.conf +++ b/ckpool.conf @@ -17,6 +17,7 @@ "update_interval" : 30, "serverurl" : "ckpool.org:3333", "mindiff" : 1, -"startdiff" : 1, +"startdiff" : 42, "logdir" : "logs" } +Comments from here on are ignored. diff --git a/ckproxy.conf b/ckproxy.conf index af528c1d..b4e3f2bf 100644 --- a/ckproxy.conf +++ b/ckproxy.conf @@ -14,6 +14,7 @@ "update_interval" : 30, "serverurl" : "192.168.1.100:3334", "mindiff" : 1, -"startdiff" : 1, +"startdiff" : 42, "logdir" : "logs" } +Comments from here on are ignored.