move docs to zebra book

This commit is contained in:
Alfredo Garcia 2020-07-28 19:06:56 -03:00 committed by Henry de Valence
parent 6297a7cd19
commit 617f1d80ef
8 changed files with 47 additions and 27 deletions

View File

@ -13,3 +13,10 @@
- [Design Documents](design_docs.md)
- [Pipelinable Block Lookup](./designs/0001-pipelinable-block-lookup.md)
# Applications
- [Applications](applications.md)
- [zebrad](./applications/zebrad.md)
- [Enviroment variables](./applications/zebrad/enviroment-variables.md)
- [utils](./applications/utils.md)
- [zebra-checkpoints](./applications/utils/zebra-checkpoints.md)

4
book/src/applications.md Normal file
View File

@ -0,0 +1,4 @@
# Applications
- [zebrad](applications/zebrad.md)
- [zebra-checkpoints](applications/utils/zebra-checkpoints.md)

View File

@ -0,0 +1 @@
# utils

View File

@ -0,0 +1 @@
# zebra-checkpoints

View File

@ -0,0 +1 @@
# zebra-checkpoints

View File

@ -0,0 +1,4 @@
# zebrad
- [Enviroment variables](./zebrad/enviroment-variables.md)

View File

@ -0,0 +1,29 @@
# Zebrad enviroment variables
All zebrad subcommands support the following enviroment variables:
- `ZEBRAD_CACHE_DIR`: The directory to store zebra data just as state, blocks, wallet, etc.
- `ZEBRAD_LOG`: Manipulate the log level. Regex is supported.
## Examples:
Use a custom data directory:
```
export ZEBRAD_CACHE_DIR="/my/zebra_data_dir"
zebrad start
```
Output all info messages:
```
export ZEBRAD_LOG="info"
zebrad start
```
Output block_verify with trace level and above every 1000 blocks:
```
export ZEBRAD_LOG="[block_verify{height=Some\(BlockHeight\(.*000\)\)}]=trace"
zebrad start
```
Note: Log options are processed in this order: verbose flag, command stdout, enviroment variable, config file.

View File

@ -24,33 +24,6 @@ use std::path::PathBuf;
pub const CONFIG_FILE: &str = "zebrad.toml";
/// Zebrad Subcommands
///
/// All subcommands support the following enviroment variables:
/// - `ZEBRAD_CACHE_DIR`: The directory to store zebra data just as state, blocks, wallet, etc.
/// - `ZEBRAD_LOG`: Manipulate the log level. Regex is supported.
/// ## Examples:
///
/// Use a custom data directory:
/// ```
/// export ZEBRAD_CACHE_DIR="/my/zebra_data_dir"
/// zebrad start
/// ```
///
/// Output all info messages:
///
/// ```
/// export ZEBRAD_LOG="info"
/// zebrad start
/// ```
///
/// Output block_verify with trace level and above every 1000 blocks:
///
/// ```
/// export ZEBRAD_LOG="[block_verify{height=Some\(BlockHeight\(.*000\)\)}]=trace"
/// zebrad start
/// ```
///
/// Note: Log options are processed in this order: verbose flag, command stdout, enviroment variable, config file.
#[derive(Command, Debug, Options, Runnable)]
pub enum ZebradCmd {
/// The `generate` subcommand