Bitcoind
services.bitcoind.<name>.configFile
The configuration file path to supply bitcoind.
Type: null or path
Default
null
Example
"/var/lib/‹name›/bitcoin.conf"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.dataDir
The data directory for bitcoind.
Type: path
Default
"/var/lib/bitcoind-‹name›"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.dbCache
Override the default database cache size in MiB.
Type: null or integer between 4 and 16384 (both inclusive)
Default
null
Example
4000
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.enable
Whether to enable Bitcoin daemon.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.extraCmdlineOptions
Extra command line options to pass to bitcoind. Run bitcoind --help to list all available options.
Type: list of string
Default
[ ]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.extraConfig
Additional configurations to be appended to {file}bitcoin.conf
.
Type: strings concatenated with "\n"
Default
""
Example
'' par=16 rpcthreads=16 logips=1''
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.group
The group as which to run bitcoind.
Type: string
Default
"bitcoind-‹name›"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.package
The bitcoind package to use.
Type: package
Default
pkgs.bitcoind
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.pidFile
Location of bitcoind pid file.
Type: path
Default
"/var/lib/bitcoind-‹name›/bitcoind.pid"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.port
Override the default port on which to listen for connections.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.prune
Reduce storage requirements by enabling pruning (deleting) of old blocks. This allows the pruneblockchain RPC to be called to delete 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).
Type: null or ((unsigned integer, meaning >=0) or (one of "disable", "manual") convertible to it)
Default
null
Example
10000
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.rpc.port
Override the default port on which to listen for JSON-RPC connections.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.rpc.users
RPC user information for JSON-RPC connections.
Type: attribute set of (submodule)
Default
{ }
Example
{alice.passwordHMAC = "f7efda5c189b999524f151318c0c86$d5b51b3beffbc02b724e5d095828e0bc8b2456e9ac8757ae3211a5d9b16a22ae";bob.passwordHMAC = "b2dd077cb54591a2f3139e69a897ac$4e71f08d48b4347cf8eff3815c0e25ae2e9a4340474079f55705f40574f4ec99";}
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.rpc.users.<name>.name
Username for JSON-RPC connections.
Type: string
Example
"alice"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.rpc.users.<name>.passwordHMAC
Password HMAC-SHA-256 for JSON-RPC connections. Must be a string of the format \<SALT-HEX>$\<HMAC-HEX>.
Tool (Python script) for HMAC generation is available here: https://github.com/bitcoin/bitcoin/blob/master/share/rpcauth/rpcauth.py
Type: string matching the pattern [0-9a-f]+\$[0-9a-f]{64}
Example
"f7efda5c189b999524f151318c0c86$d5b51b3beffbc02b724e5d095828e0bc8b2456e9ac8757ae3211a5d9b16a22ae"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.testnet
Whether to use the testnet instead of mainnet.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix
services.bitcoind.<name>.user
The user as which to run bitcoind.
Type: string
Default
"bitcoind-‹name›"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/bitcoind.nix