From 58b296da388adfc90de617dd15375a4876af75ab Mon Sep 17 00:00:00 2001 From: Con Kolivas Date: Thu, 11 Jun 2015 20:12:27 +1000 Subject: [PATCH] Document redirector option and configuration --- README | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README b/README index c701deb0..a9a162fc 100644 --- a/README +++ b/README @@ -131,6 +131,7 @@ ckpool supports the following options: -n NAME | --name NAME -P | --passthrough -p | --proxy +-R | --redirector -S CKDB-SOCKDIR | --ckdb-sockdir CKDB-SOCKDIR -s SOCKDIR | --sockdir SOCKDIR @@ -179,6 +180,13 @@ clients as separate entities while presenting shares as a single user to the upstream pool specified. Note that the upstream pool needs to be a ckpool for it to scale to large hashrates. Standalone mode is Optional. +-R will start ckpool in a variant of passthrough mode. It is designed to be a +front end to filter out users that never contribute any shares. Once an +accepted share from the upstream pool is detected, it will issue a redirect to +one of the redirecturl entries in the configuration file. It will cycle over +entries if multiple exist, but try to keep all clients from the same IP +redirecting to the same pool. + -S tells ckpool which directory to look for the ckdb socket to talk to. This option does not exist when built without ckdb support. @@ -256,6 +264,9 @@ and 3334 in proxy mode. Multiple entries can be specified as an array by either IP or resolvable domain name but the executable must be able to bind to all of them and ports up to 1024 usually require privileged access. +"redirecturl" : This is an array of URLs that ckpool will redirect active +miners to in redirector mode. They must be valid resolvable URLs+ports. + "mindiff" : Minimum diff that vardiff will allow miners to drop to. Default 1 "startdiff" : Starting diff that new clients are given. Default 42