mirrors/electrs
1
0
Fork 0
mirror of https://github.com/romanz/electrs.git synced 2024-11-19 09:54:09 +01:00
Code Issues Projects Releases Wiki Activity
c32e553cac
electrs/config_spec.toml

118 lines
3.9 KiB
TOML
Raw Normal View History

Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[general]
env_prefix = "ELECTRS"
Support for user-specified onfiguration files/dirs This commit upgrades `configure_me` and adds support for `--conf` and `--conf-dir` parameters, which load the configuration from the specified place.
2019-09-28 22:42:23 +02:00
conf_file_param = "conf"
conf_dir_param = "conf_dir"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
doc = """
An efficient re-implementation of Electrum Server, inspired by ElectrumX, Electrum Personal Server and bitcoincore-indexd.
The motivation behind this project is to enable a user to run his own Electrum server, with required hardware resources not much beyond those of a full node. The server indexes the entire Bitcoin blockchain, and the resulting index enables fast queries for any given user wallet, allowing the user to keep real-time track of his balances and his transaction history using the Electrum wallet. Since it runs on the user's own machine, there is no need for the wallet to communicate with external Electrum servers, thus preserving the privacy of the user's addresses and balances."""
[[switch]]
name = "verbose"
abbr = "v"
doc = "Increase logging verbosity"
count = true
[[switch]]
name = "timestamp"
doc = "Prepend log lines with a timestamp"
[[param]]
name = "db_dir"
type = "std::path::PathBuf"
doc = "Directory to store index database (default: ./db/)"
default = "\"./db\".into()"
[[param]]
name = "daemon_dir"
type = "std::path::PathBuf"
doc = "Data directory of Bitcoind (default: ~/.bitcoin/)"
default = "crate::config::default_daemon_dir()"
Add a 'blocks_dir' option analogous to bitcoind's '-blocksdir' The '-blocksdir' startup option allows one to store blk*.dat on an external disk, while keeping the index (blocks/index/) on the same disk. This makes electrs aware of such an option, while still keeping the same default behaviour (blk*.dat in '<config_dir>/blocks/'). Signed-off-by: Antoine Poinsot <darosior@protonmail.com>
2020-06-30 11:50:05 +02:00
[[param]]
name = "blocks_dir"
type = "std::path::PathBuf"
doc = "Analogous to bitcoind's -blocksdir option, this specifies the directory containing the raw blocks files (blk*.dat)"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "cookie"
type = "String"
Implemented custom cookie file This change allows the user to specify a custom cookie file, which is then used instead of `~/.bitcoin/.cookie`. This resolves situations when the user wants to have the cookie file in non-standard path. Aside from that, the code now pre-computes the default path, improving the performance by avoiding allocation (and copying). Unfortunately, due to limitations of Rust, the code doesn't print out cookie configuration anymore. This however might be safer, since the cookie isn't printed, and thus doesn't end up in some readable logs by accident. Closes #176 Closes #189
2019-11-10 12:11:31 +01:00
doc = "JSONRPC authentication cookie ('USER:PASSWORD', default: read from cookie file)"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
# Force the user to use config file in order to avoid password leaks
argument = false
env_var = false
Implemented custom cookie file This change allows the user to specify a custom cookie file, which is then used instead of `~/.bitcoin/.cookie`. This resolves situations when the user wants to have the cookie file in non-standard path. Aside from that, the code now pre-computes the default path, improving the performance by avoiding allocation (and copying). Unfortunately, due to limitations of Rust, the code doesn't print out cookie configuration anymore. This however might be safer, since the cookie isn't printed, and thus doesn't end up in some readable logs by accident. Closes #176 Closes #189
2019-11-10 12:11:31 +01:00
[[param]]
name = "cookie_file"
type = "std::path::PathBuf"
doc = "JSONRPC authentication cookie file (default: ~/.bitcoin/.cookie)"
# This is safe to configure on command line.
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "network"
type = "crate::config::BitcoinNetwork"
convert_into = "::bitcoin::network::constants::Network"
Correct --network arg values in the doc After a recent switch to configure_me in ec049b9a, the 'mainnet' arg value became 'bitcoin'. 2c50791d then updated db dir location but the doc for the --network arg remained stale. An alternative is to accept both 'mainnet' and 'bitcoin' but it would be confusing IMHO.
2019-12-15 13:34:26 +01:00
doc = "Select Bitcoin network type ('bitcoin', 'testnet' or 'regtest')"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
default = "Default::default()"
[[param]]
name = "electrum_rpc_addr"
type = "crate::config::ResolvAddr"
doc = "Electrum server JSONRPC 'addr:port' to listen on (default: '127.0.0.1:50001' for mainnet, '127.0.0.1:60001' for testnet and '127.0.0.1:60401' for regtest)"
[[param]]
name = "daemon_rpc_addr"
type = "crate::config::ResolvAddr"
doc = "Bitcoin daemon JSONRPC 'addr:port' to connect (default: 127.0.0.1:8332 for mainnet, 127.0.0.1:18332 for testnet and 127.0.0.1:18443 for regtest)"
[[param]]
name = "monitoring_addr"
type = "crate::config::ResolvAddr"
doc = "Prometheus monitoring 'addr:port' to listen on (default: 127.0.0.1:4224 for mainnet, 127.0.0.1:14224 for testnet and 127.0.0.1:24224 for regtest)"
[[switch]]
name = "jsonrpc_import"
doc = "Use JSONRPC instead of directly importing blk*.dat files. Useful for remote full node or low memory system"
Allow configuring wait duration
2020-06-13 17:15:03 +02:00
[[param]]
name = "wait_duration_secs"
type = "u64"
doc = "Duration to wait between bitcoind polling"
default = "5"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "index_batch_size"
type = "usize"
doc = "Number of blocks to get in one JSONRPC request from bitcoind"
default = "100"
[[param]]
name = "bulk_index_threads"
type = "usize"
doc = "Number of threads used for bulk indexing (default: use the # of CPUs)"
default = "0"
[[param]]
Add byte-size limit to transaction & block txids' caches Also, move TransactionCache into `cache` module. Following https://github.com/romanz/electrs/pull/161 by @dagurval. Co-authored-by: Dagur Valberg Johannsson <dagurval@pvv.ntnu.no>
2019-09-14 11:11:54 +02:00
name = "tx_cache_size_mb"
type = "f32"
doc = "Total size of transactions to cache (MB)"
default = "10.0"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
Add byte-size limit to transaction & block txids' caches Also, move TransactionCache into `cache` module. Following https://github.com/romanz/electrs/pull/161 by @dagurval. Co-authored-by: Dagur Valberg Johannsson <dagurval@pvv.ntnu.no>
2019-09-14 11:11:54 +02:00
name = "blocktxids_cache_size_mb"
type = "f32"
doc = "Total size of block transactions IDs to cache (in MB)"
default = "10.0"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "txid_limit"
type = "usize"
doc = "Number of transactions to lookup before returning an error, to prevent 'too popular' addresses from causing the RPC server to get stuck (0 - disable the limit)"
default = "100"
[[param]]
name = "server_banner"
type = "String"
doc = "The banner to be shown in the Electrum console"
default = "concat!(\"Welcome to electrs \", env!(\"CARGO_PKG_VERSION\"), \" (Electrum Rust Server)!\").to_owned()"
Reference in New Issue Copy Permalink