Skip to content

Commit

Permalink
Improve config documentation
Browse files Browse the repository at this point in the history
The `--skip-default-conf-files` flag is often desired but people may miss it because it's not in the doc, so this documents it.

Further, to avoid problems with people missing flags this adds a recommendation to run `electrs --help` so if we ever forget to update the doc people will learn about the new arguments anyway.

Following romanz#962.
  • Loading branch information
Kixunil authored and romanz committed Dec 1, 2023
1 parent 4f76c63 commit 1804b51
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ $ bitcoind -server=1 -txindex=0 -prune=0
```
### Electrs configuration

**Note:** this documentation may occasionally become stale. We recommend running `electrs --help` to get an up-to-date list of options.

Electrs can be configured using command line, environment variables and configuration files (or their combination).
It is highly recommended to use configuration files for any non-trivial setups since it's easier to manage.
If you're setting password manually instead of cookie files, configuration file is the only way to set it due to security reasons.
Expand All @@ -38,6 +40,7 @@ can lead to serious problems! Currently the *only* permitted operation is *delet
The Toml-formatted config files ([an example here](config_example.toml)) are (from lowest priority to highest): `/etc/electrs/config.toml`, `~/.electrs/config.toml`, `./electrs.toml`.

The options in highest-priority config files override options set in lowest-priority config files.
If loading these files is undesirable (common in case of protected systemd services), use the `--skip-default-conf-files` argument to prevent it.

**Environment variables** override options in config files and finally **arguments** override everythig else.

Expand Down

0 comments on commit 1804b51

Please sign in to comment.