bitcoind, clightning, lnd: improve descriptions
bitcoind: The previous description of 'prune' didn't match the int-only values supported by our option.
This commit is contained in:
parent
7533f12ef1
commit
c246bbb36e
@ -197,9 +197,7 @@ in {
|
|||||||
listen = mkOption {
|
listen = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = false;
|
default = false;
|
||||||
description = ''
|
description = "Accept incoming connections.";
|
||||||
If enabled, the bitcoin service will listen.
|
|
||||||
'';
|
|
||||||
};
|
};
|
||||||
dataDirReadableByGroup = mkOption {
|
dataDirReadableByGroup = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
@ -228,21 +226,15 @@ in {
|
|||||||
type = types.nullOr (types.ints.between 4 16384);
|
type = types.nullOr (types.ints.between 4 16384);
|
||||||
default = null;
|
default = null;
|
||||||
example = 4000;
|
example = 4000;
|
||||||
description = "Override the default database cache size in megabytes.";
|
description = "Override the default database cache size in MiB.";
|
||||||
};
|
};
|
||||||
prune = mkOption {
|
prune = mkOption {
|
||||||
type = types.ints.unsigned;
|
type = types.ints.unsigned;
|
||||||
default = 0;
|
default = 0;
|
||||||
example = 10000;
|
example = 10000;
|
||||||
description = ''
|
description = ''
|
||||||
Reduce storage requirements by enabling pruning (deleting) of old
|
Automatically prune block files to stay under the specified target size in MiB.
|
||||||
blocks. This allows the pruneblockchain RPC to be called to delete
|
Value 0 disables pruning.
|
||||||
specific blocks, and enables automatic pruning of old blocks if a
|
|
||||||
target size in MiB is provided. This mode is incompatible with -txindex
|
|
||||||
and -rescan. Warning: Reverting this setting requires re-downloading
|
|
||||||
the entire blockchain. ("disable" = disable pruning blocks, "manual"
|
|
||||||
= allow manual pruning via RPC, >=550 = automatically prune block files
|
|
||||||
to stay under the specified target size in MiB)
|
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
zmqpubrawblock = mkOption {
|
zmqpubrawblock = mkOption {
|
||||||
@ -281,7 +273,7 @@ in {
|
|||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
default = null;
|
default = null;
|
||||||
example = "bech32";
|
example = "bech32";
|
||||||
description = "What type of addresses to use";
|
description = "The type of addresses to use";
|
||||||
};
|
};
|
||||||
cli = mkOption {
|
cli = mkOption {
|
||||||
readOnly = true;
|
readOnly = true;
|
||||||
|
@ -41,13 +41,17 @@ in {
|
|||||||
proxy = mkOption {
|
proxy = mkOption {
|
||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
default = if cfg.enforceTor then config.services.tor.client.socksListenAddress else null;
|
default = if cfg.enforceTor then config.services.tor.client.socksListenAddress else null;
|
||||||
description = "Set a socks proxy to use to connect to Tor nodes (or for all connections if *always-use-proxy* is set)";
|
description = ''
|
||||||
|
Socks proxy for connecting to Tor nodes (or for all connections if option always-use-proxy is set).
|
||||||
|
'';
|
||||||
};
|
};
|
||||||
always-use-proxy = mkOption {
|
always-use-proxy = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = cfg.enforceTor;
|
default = cfg.enforceTor;
|
||||||
description = ''
|
description = ''
|
||||||
Always use the *proxy*, even to connect to normal IP addresses (you can still connect to Unix domain sockets manually). This also disables all DNS lookups, to avoid leaking information.
|
Always use the proxy, even to connect to normal IP addresses.
|
||||||
|
You can still connect to Unix domain sockets manually.
|
||||||
|
This also disables all DNS lookups, to avoid leaking address information.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
dataDir = mkOption {
|
dataDir = mkOption {
|
||||||
|
@ -89,7 +89,7 @@ in {
|
|||||||
tor-socks = mkOption {
|
tor-socks = mkOption {
|
||||||
type = types.nullOr types.str;
|
type = types.nullOr types.str;
|
||||||
default = if cfg.enforceTor then config.services.tor.client.socksListenAddress else null;
|
default = if cfg.enforceTor then config.services.tor.client.socksListenAddress else null;
|
||||||
description = "Set a socks proxy to use to connect to Tor nodes";
|
description = "Socks proxy for connecting to Tor nodes";
|
||||||
};
|
};
|
||||||
macaroons = mkOption {
|
macaroons = mkOption {
|
||||||
default = {};
|
default = {};
|
||||||
|
Loading…
Reference in New Issue
Block a user