add(docs): Note default path to config in docs (#8143)
* Note default path to config file in README and docs * Applies suggestions from review & adds new test config file * removes default path for 'Other' OSes from ZebradConfig docs * fixes config_tests
This commit is contained in:
parent
07693a1596
commit
81a3a2aacf
|
@ -117,6 +117,14 @@ sections in the book for more details.
|
||||||
|
|
||||||
#### Optional Configs & Features
|
#### Optional Configs & Features
|
||||||
|
|
||||||
|
##### Initializing Configuration File
|
||||||
|
|
||||||
|
```console
|
||||||
|
zebrad generate -o ~/.config/zebrad.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
The above command places the generated `zebrad.toml` config file in the default preferences directory of Linux. For other OSes default locations [see here](https://docs.rs/dirs/latest/dirs/fn.preference_dir.html).
|
||||||
|
|
||||||
##### Configuring Progress Bars
|
##### Configuring Progress Bars
|
||||||
|
|
||||||
Configure `tracing.progress_bar` in your `zebrad.toml` to
|
Configure `tracing.progress_bar` in your `zebrad.toml` to
|
||||||
|
|
|
@ -44,6 +44,15 @@ impl Runnable for GenerateCmd {
|
||||||
# 1. The -c flag on the command line, e.g., `zebrad -c myconfig.toml start`;
|
# 1. The -c flag on the command line, e.g., `zebrad -c myconfig.toml start`;
|
||||||
# 2. The file `zebrad.toml` in the users's preference directory (platform-dependent);
|
# 2. The file `zebrad.toml` in the users's preference directory (platform-dependent);
|
||||||
# 3. The default config.
|
# 3. The default config.
|
||||||
|
#
|
||||||
|
# The user's preference directory and the default path to the `zebrad` config are platform dependent,
|
||||||
|
# based on `dirs::preference_dir`, see https://docs.rs/dirs/latest/dirs/fn.preference_dir.html :
|
||||||
|
#
|
||||||
|
# | Platform | Value | Example |
|
||||||
|
# | -------- | ------------------------------------- | ---------------------------------------------- |
|
||||||
|
# | Linux | `$XDG_CONFIG_HOME` or `$HOME/.config` | `/home/alice/.config/zebrad.toml` |
|
||||||
|
# | macOS | `$HOME/Library/Preferences` | `/Users/Alice/Library/Preferences/zebrad.toml` |
|
||||||
|
# | Windows | `{FOLDERID_RoamingAppData}` | `C:\Users\Alice\AppData\Local\zebrad.toml` |
|
||||||
|
|
||||||
"
|
"
|
||||||
.to_owned();
|
.to_owned();
|
||||||
|
|
|
@ -11,6 +11,17 @@ use serde::{Deserialize, Serialize};
|
||||||
/// The `zebrad` config is a TOML-encoded version of this structure. The meaning
|
/// The `zebrad` config is a TOML-encoded version of this structure. The meaning
|
||||||
/// of each field is described in the documentation, although it may be necessary
|
/// of each field is described in the documentation, although it may be necessary
|
||||||
/// to click through to the sub-structures for each section.
|
/// to click through to the sub-structures for each section.
|
||||||
|
///
|
||||||
|
/// The path to the configuration file can also be specified with the `--config` flag when running Zebra.
|
||||||
|
///
|
||||||
|
/// The default path to the `zebrad` config is platform dependent, based on
|
||||||
|
/// [`dirs::preference_dir`](https://docs.rs/dirs/latest/dirs/fn.preference_dir.html):
|
||||||
|
///
|
||||||
|
/// | Platform | Value | Example |
|
||||||
|
/// | -------- | ------------------------------------- | ---------------------------------------------- |
|
||||||
|
/// | Linux | `$XDG_CONFIG_HOME` or `$HOME/.config` | `/home/alice/.config/zebrad.toml` |
|
||||||
|
/// | macOS | `$HOME/Library/Preferences` | `/Users/Alice/Library/Preferences/zebrad.toml` |
|
||||||
|
/// | Windows | `{FOLDERID_RoamingAppData}` | `C:\Users\Alice\AppData\Local\zebrad.toml` |
|
||||||
#[derive(Clone, Default, Debug, Eq, PartialEq, Deserialize, Serialize)]
|
#[derive(Clone, Default, Debug, Eq, PartialEq, Deserialize, Serialize)]
|
||||||
#[serde(deny_unknown_fields, default)]
|
#[serde(deny_unknown_fields, default)]
|
||||||
pub struct ZebradConfig {
|
pub struct ZebradConfig {
|
||||||
|
|
|
@ -54,6 +54,16 @@
|
||||||
//! - Additional contexts: wider target deployments for people to use a consensus
|
//! - Additional contexts: wider target deployments for people to use a consensus
|
||||||
//! node in more contexts e.g. mobile, wasm, etc.
|
//! node in more contexts e.g. mobile, wasm, etc.
|
||||||
//!
|
//!
|
||||||
|
//! ## Configuration
|
||||||
|
//!
|
||||||
|
//! The command below places the generated `zebrad.toml` config file in the default preferences directory of Linux:
|
||||||
|
//!
|
||||||
|
//! ```console
|
||||||
|
//! zebrad generate -o ~/.config/zebrad.toml
|
||||||
|
//! ```
|
||||||
|
//!
|
||||||
|
//! See [`config::ZebradConfig`] for other OSes default locations or more information about how to configure Zebra.
|
||||||
|
//!
|
||||||
//! ## Zebra Feature Flags
|
//! ## Zebra Feature Flags
|
||||||
//!
|
//!
|
||||||
//! The following `zebrad` feature flags are available at compile time:
|
//! The following `zebrad` feature flags are available at compile time:
|
||||||
|
|
|
@ -0,0 +1,89 @@
|
||||||
|
# Default configuration for zebrad.
|
||||||
|
#
|
||||||
|
# This file can be used as a skeleton for custom configs.
|
||||||
|
#
|
||||||
|
# Unspecified fields use default values. Optional fields are Some(field) if the
|
||||||
|
# field is present and None if it is absent.
|
||||||
|
#
|
||||||
|
# This file is generated as an example using zebrad's current defaults.
|
||||||
|
# You should set only the config options you want to keep, and delete the rest.
|
||||||
|
# Only a subset of fields are present in the skeleton, since optional values
|
||||||
|
# whose default is None are omitted.
|
||||||
|
#
|
||||||
|
# The config format (including a complete list of sections and fields) is
|
||||||
|
# documented here:
|
||||||
|
# https://docs.rs/zebrad/latest/zebrad/config/struct.ZebradConfig.html
|
||||||
|
#
|
||||||
|
# zebrad attempts to load configs in the following order:
|
||||||
|
#
|
||||||
|
# 1. The -c flag on the command line, e.g., `zebrad -c myconfig.toml start`;
|
||||||
|
# 2. The file `zebrad.toml` in the users's preference directory (platform-dependent);
|
||||||
|
# 3. The default config.
|
||||||
|
#
|
||||||
|
# The user's preference directory and the default path to the `zebrad` config are platform dependent,
|
||||||
|
# based on `dirs::preference_dir`, see https://docs.rs/dirs/latest/dirs/fn.preference_dir.html :
|
||||||
|
#
|
||||||
|
# | Platform | Value | Example |
|
||||||
|
# | -------- | ------------------------------------- | ---------------------------------------------- |
|
||||||
|
# | Linux | `$XDG_CONFIG_HOME` or `$HOME/.config` | `/home/alice/.config/zebrad.toml` |
|
||||||
|
# | macOS | `$HOME/Library/Preferences` | `/Users/Alice/Library/Preferences/zebrad.toml` |
|
||||||
|
# | Windows | `{FOLDERID_RoamingAppData}` | `C:\Users\Alice\AppData\Local\zebrad.toml` |
|
||||||
|
|
||||||
|
[consensus]
|
||||||
|
checkpoint_sync = true
|
||||||
|
|
||||||
|
[mempool]
|
||||||
|
eviction_memory_time = "1h"
|
||||||
|
tx_cost_limit = 80000000
|
||||||
|
|
||||||
|
[metrics]
|
||||||
|
|
||||||
|
[mining]
|
||||||
|
debug_like_zcashd = true
|
||||||
|
|
||||||
|
[network]
|
||||||
|
cache_dir = true
|
||||||
|
crawl_new_peer_interval = "1m 1s"
|
||||||
|
initial_mainnet_peers = [
|
||||||
|
"dnsseed.z.cash:8233",
|
||||||
|
"dnsseed.str4d.xyz:8233",
|
||||||
|
"mainnet.seeder.zfnd.org:8233",
|
||||||
|
"mainnet.is.yolo.money:8233",
|
||||||
|
]
|
||||||
|
initial_testnet_peers = [
|
||||||
|
"dnsseed.testnet.z.cash:18233",
|
||||||
|
"testnet.seeder.zfnd.org:18233",
|
||||||
|
"testnet.is.yolo.money:18233",
|
||||||
|
]
|
||||||
|
listen_addr = "0.0.0.0:8233"
|
||||||
|
max_connections_per_ip = 1
|
||||||
|
network = "Mainnet"
|
||||||
|
peerset_initial_target_size = 25
|
||||||
|
|
||||||
|
[rpc]
|
||||||
|
debug_force_finished_sync = false
|
||||||
|
parallel_cpu_threads = 0
|
||||||
|
|
||||||
|
[shielded_scan]
|
||||||
|
cache_dir = "cache_dir"
|
||||||
|
delete_old_database = true
|
||||||
|
ephemeral = false
|
||||||
|
|
||||||
|
[shielded_scan.sapling_keys_to_scan]
|
||||||
|
|
||||||
|
[state]
|
||||||
|
cache_dir = "cache_dir"
|
||||||
|
delete_old_database = true
|
||||||
|
ephemeral = false
|
||||||
|
|
||||||
|
[sync]
|
||||||
|
checkpoint_verify_concurrency_limit = 1000
|
||||||
|
download_concurrency_limit = 50
|
||||||
|
full_verify_concurrency_limit = 20
|
||||||
|
parallel_cpu_threads = 0
|
||||||
|
|
||||||
|
[tracing]
|
||||||
|
buffer_limit = 128000
|
||||||
|
force_use_color = false
|
||||||
|
use_color = true
|
||||||
|
use_journald = false
|
|
@ -0,0 +1,82 @@
|
||||||
|
# Default configuration for zebrad.
|
||||||
|
#
|
||||||
|
# This file can be used as a skeleton for custom configs.
|
||||||
|
#
|
||||||
|
# Unspecified fields use default values. Optional fields are Some(field) if the
|
||||||
|
# field is present and None if it is absent.
|
||||||
|
#
|
||||||
|
# This file is generated as an example using zebrad's current defaults.
|
||||||
|
# You should set only the config options you want to keep, and delete the rest.
|
||||||
|
# Only a subset of fields are present in the skeleton, since optional values
|
||||||
|
# whose default is None are omitted.
|
||||||
|
#
|
||||||
|
# The config format (including a complete list of sections and fields) is
|
||||||
|
# documented here:
|
||||||
|
# https://docs.rs/zebrad/latest/zebrad/config/struct.ZebradConfig.html
|
||||||
|
#
|
||||||
|
# zebrad attempts to load configs in the following order:
|
||||||
|
#
|
||||||
|
# 1. The -c flag on the command line, e.g., `zebrad -c myconfig.toml start`;
|
||||||
|
# 2. The file `zebrad.toml` in the users's preference directory (platform-dependent);
|
||||||
|
# 3. The default config.
|
||||||
|
#
|
||||||
|
# The user's preference directory and the default path to the `zebrad` config are platform dependent,
|
||||||
|
# based on `dirs::preference_dir`, see https://docs.rs/dirs/latest/dirs/fn.preference_dir.html :
|
||||||
|
#
|
||||||
|
# | Platform | Value | Example |
|
||||||
|
# | -------- | ------------------------------------- | ---------------------------------------------- |
|
||||||
|
# | Linux | `$XDG_CONFIG_HOME` or `$HOME/.config` | `/home/alice/.config/zebrad.toml` |
|
||||||
|
# | macOS | `$HOME/Library/Preferences` | `/Users/Alice/Library/Preferences/zebrad.toml` |
|
||||||
|
# | Windows | `{FOLDERID_RoamingAppData}` | `C:\Users\Alice\AppData\Local\zebrad.toml` |
|
||||||
|
|
||||||
|
[consensus]
|
||||||
|
checkpoint_sync = true
|
||||||
|
|
||||||
|
[mempool]
|
||||||
|
eviction_memory_time = "1h"
|
||||||
|
tx_cost_limit = 80000000
|
||||||
|
|
||||||
|
[metrics]
|
||||||
|
|
||||||
|
[mining]
|
||||||
|
debug_like_zcashd = true
|
||||||
|
|
||||||
|
[network]
|
||||||
|
cache_dir = true
|
||||||
|
crawl_new_peer_interval = "1m 1s"
|
||||||
|
initial_mainnet_peers = [
|
||||||
|
"dnsseed.z.cash:8233",
|
||||||
|
"dnsseed.str4d.xyz:8233",
|
||||||
|
"mainnet.seeder.zfnd.org:8233",
|
||||||
|
"mainnet.is.yolo.money:8233",
|
||||||
|
]
|
||||||
|
initial_testnet_peers = [
|
||||||
|
"dnsseed.testnet.z.cash:18233",
|
||||||
|
"testnet.seeder.zfnd.org:18233",
|
||||||
|
"testnet.is.yolo.money:18233",
|
||||||
|
]
|
||||||
|
listen_addr = "0.0.0.0:8233"
|
||||||
|
max_connections_per_ip = 1
|
||||||
|
network = "Mainnet"
|
||||||
|
peerset_initial_target_size = 25
|
||||||
|
|
||||||
|
[rpc]
|
||||||
|
debug_force_finished_sync = false
|
||||||
|
parallel_cpu_threads = 0
|
||||||
|
|
||||||
|
[state]
|
||||||
|
cache_dir = "cache_dir"
|
||||||
|
delete_old_database = true
|
||||||
|
ephemeral = false
|
||||||
|
|
||||||
|
[sync]
|
||||||
|
checkpoint_verify_concurrency_limit = 1000
|
||||||
|
download_concurrency_limit = 50
|
||||||
|
full_verify_concurrency_limit = 20
|
||||||
|
parallel_cpu_threads = 0
|
||||||
|
|
||||||
|
[tracing]
|
||||||
|
buffer_limit = 128000
|
||||||
|
force_use_color = false
|
||||||
|
use_color = true
|
||||||
|
use_journald = false
|
Loading…
Reference in New Issue