Tidy config: drop payout-address field, group niche options under Advanced
Worker stratum username is the payout address in ckpool-solo, so the separate field was redundant. Niche vardiff/logging/zmq knobs now live under an Advanced group with sensible defaults.
This commit is contained in:
@@ -4,10 +4,11 @@ export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({
|
||||
"bitcoind": {
|
||||
"type": "union",
|
||||
"name": "Bitcoin Core",
|
||||
"description": "Select which Bitcoin Core node Kamado should use.",
|
||||
"description":
|
||||
"Select which Bitcoin Core node Kamado should use. Both variants work — pick whichever is installed on your server.",
|
||||
"tag": {
|
||||
"id": "type",
|
||||
"name": "Type",
|
||||
"name": "Network",
|
||||
"description": "Mainnet bitcoind or the testnet4 variant.",
|
||||
"variant-names": {
|
||||
"bitcoind": "Bitcoin Core (mainnet)",
|
||||
@@ -62,30 +63,11 @@ export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({
|
||||
},
|
||||
},
|
||||
},
|
||||
"pool-address": {
|
||||
"type": "string",
|
||||
"name": "Payout Address",
|
||||
"description":
|
||||
"Bitcoin address that receives the full block reward when a block is solved. Solo mining — no fees, no splits.",
|
||||
"nullable": false,
|
||||
"masked": false,
|
||||
"copyable": true,
|
||||
},
|
||||
"pool-identifier": {
|
||||
"type": "string",
|
||||
"name": "Coinbase Tag",
|
||||
"description":
|
||||
"Short string embedded in the coinbase transaction of solved blocks. Max 32 characters.",
|
||||
"nullable": false,
|
||||
"default": "/Kamado/",
|
||||
"masked": false,
|
||||
"copyable": false,
|
||||
},
|
||||
"stratum-port": {
|
||||
"type": "number",
|
||||
"name": "Stratum Port",
|
||||
"description":
|
||||
"TCP port the plaintext stratum server listens on inside the container. Defaults to 3333. Change this if you are running simpleproxy (or another TCP forwarder) and want Kamado to listen on a different port.",
|
||||
"TCP port the plaintext stratum server listens on inside the container. Most miners connect here.",
|
||||
"nullable": false,
|
||||
"default": 3333,
|
||||
"range": "[1,65535]",
|
||||
@@ -95,14 +77,14 @@ export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({
|
||||
"type": "union",
|
||||
"name": "Stratum TLS",
|
||||
"description":
|
||||
"Accept stratum connections over TLS via an stunnel sidecar. A self-signed certificate is generated on first start and persisted across restarts — miners must connect with TLS verification disabled (most firmware exposes this as 'stratum+ssl://' with a skip-verify or insecure flag).",
|
||||
"Optionally accept stratum connections over TLS via an stunnel sidecar. A self-signed certificate is generated once on first start and persisted — miners must connect with TLS verification disabled (stratum+ssl:// plus a skip-verify flag).",
|
||||
"tag": {
|
||||
"id": "enabled",
|
||||
"name": "TLS Mode",
|
||||
"description": "Disable or enable TLS termination in front of stratum.",
|
||||
"name": "Mode",
|
||||
"description": "Disable or enable TLS termination.",
|
||||
"variant-names": {
|
||||
"disabled": "Disabled",
|
||||
"enabled": "Enabled (stunnel sidecar)",
|
||||
"enabled": "Enabled",
|
||||
},
|
||||
},
|
||||
"default": "disabled",
|
||||
@@ -111,9 +93,9 @@ export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({
|
||||
"enabled": {
|
||||
"port": {
|
||||
"type": "number",
|
||||
"name": "TLS Stratum Port",
|
||||
"name": "TLS Port",
|
||||
"description":
|
||||
"TCP port stunnel listens on for TLS stratum connections. Forwards decrypted traffic to the plaintext stratum port locally.",
|
||||
"TCP port stunnel listens on for TLS stratum connections.",
|
||||
"nullable": false,
|
||||
"default": 3334,
|
||||
"range": "[1,65535]",
|
||||
@@ -122,62 +104,81 @@ export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({
|
||||
},
|
||||
},
|
||||
},
|
||||
"startdiff": {
|
||||
"type": "number",
|
||||
"name": "Starting Difficulty",
|
||||
"advanced": {
|
||||
"type": "object",
|
||||
"name": "Advanced",
|
||||
"description":
|
||||
"Initial vardiff target for new miner connections. Bitaxe-class miners typically land around 16384.",
|
||||
"nullable": false,
|
||||
"default": 16384,
|
||||
"range": "[1,*)",
|
||||
"integral": true,
|
||||
},
|
||||
"mindiff": {
|
||||
"type": "number",
|
||||
"name": "Minimum Difficulty",
|
||||
"description": "Floor for the vardiff algorithm.",
|
||||
"nullable": false,
|
||||
"default": 1000,
|
||||
"range": "[1,*)",
|
||||
"integral": true,
|
||||
},
|
||||
"maxdiff": {
|
||||
"type": "number",
|
||||
"name": "Maximum Difficulty",
|
||||
"description": "Ceiling for the vardiff algorithm. 0 means no cap.",
|
||||
"nullable": false,
|
||||
"default": 0,
|
||||
"range": "[0,*)",
|
||||
"integral": true,
|
||||
},
|
||||
"dropidle": {
|
||||
"type": "number",
|
||||
"name": "Drop Idle (seconds)",
|
||||
"description":
|
||||
"Disconnect clients that have not submitted a share in this many seconds. 0 disables the idle disconnect.",
|
||||
"nullable": false,
|
||||
"default": 0,
|
||||
"range": "[0,*)",
|
||||
"integral": true,
|
||||
},
|
||||
"zmq-enabled": {
|
||||
"type": "boolean",
|
||||
"name": "Enable ZMQ Block Notifications",
|
||||
"description":
|
||||
"Subscribe to Bitcoin Core's hashblock ZMQ topic for sub-second chain refresh on the dashboard. Requires zmqpubhashblock to be enabled on your bitcoind — the default StartOS bitcoind package exposes it on tcp://bitcoind.embassy:28332.",
|
||||
"default": true,
|
||||
},
|
||||
"log-level": {
|
||||
"type": "enum",
|
||||
"name": "Log Level",
|
||||
"description": "Verbosity of the kamado-api log output.",
|
||||
"values": ["debug", "info", "warn", "error"],
|
||||
"value-names": {
|
||||
"debug": "Debug",
|
||||
"info": "Info",
|
||||
"warn": "Warn",
|
||||
"error": "Error",
|
||||
"Fine-tuning knobs for vardiff, logging, and block notifications. Safe to ignore — the defaults work well for Bitaxe-class miners.",
|
||||
"spec": {
|
||||
"pool-identifier": {
|
||||
"type": "string",
|
||||
"name": "Coinbase Tag",
|
||||
"description":
|
||||
"Short string embedded in the coinbase transaction of solved blocks.",
|
||||
"nullable": false,
|
||||
"default": "/Kamado/",
|
||||
"masked": false,
|
||||
"copyable": false,
|
||||
},
|
||||
"startdiff": {
|
||||
"type": "number",
|
||||
"name": "Starting Difficulty",
|
||||
"description":
|
||||
"Initial vardiff target for new miner connections. Bitaxe-class miners typically land around 16384.",
|
||||
"nullable": false,
|
||||
"default": 16384,
|
||||
"range": "[1,*)",
|
||||
"integral": true,
|
||||
},
|
||||
"mindiff": {
|
||||
"type": "number",
|
||||
"name": "Minimum Difficulty",
|
||||
"description": "Floor for the vardiff algorithm.",
|
||||
"nullable": false,
|
||||
"default": 1000,
|
||||
"range": "[1,*)",
|
||||
"integral": true,
|
||||
},
|
||||
"maxdiff": {
|
||||
"type": "number",
|
||||
"name": "Maximum Difficulty",
|
||||
"description":
|
||||
"Ceiling for the vardiff algorithm. 0 means no cap.",
|
||||
"nullable": false,
|
||||
"default": 0,
|
||||
"range": "[0,*)",
|
||||
"integral": true,
|
||||
},
|
||||
"dropidle": {
|
||||
"type": "number",
|
||||
"name": "Drop Idle (seconds)",
|
||||
"description":
|
||||
"Disconnect clients that have not submitted a share in this many seconds. 0 disables the idle disconnect.",
|
||||
"nullable": false,
|
||||
"default": 0,
|
||||
"range": "[0,*)",
|
||||
"integral": true,
|
||||
},
|
||||
"zmq-enabled": {
|
||||
"type": "boolean",
|
||||
"name": "Enable ZMQ Block Notifications",
|
||||
"description":
|
||||
"Subscribe to Bitcoin Core's hashblock ZMQ topic for sub-second chain refresh on the dashboard. Requires zmqpubhashblock on bitcoind.",
|
||||
"default": true,
|
||||
},
|
||||
"log-level": {
|
||||
"type": "enum",
|
||||
"name": "Log Level",
|
||||
"description": "Verbosity of the kamado-api log output.",
|
||||
"values": ["debug", "info", "warn", "error"],
|
||||
"value-names": {
|
||||
"debug": "Debug",
|
||||
"info": "Info",
|
||||
"warn": "Warn",
|
||||
"error": "Error",
|
||||
},
|
||||
"default": "info",
|
||||
},
|
||||
},
|
||||
"default": "info",
|
||||
},
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user