Skip to content

Commit

Permalink
Explain behavior of config file loading
Browse files Browse the repository at this point in the history
Previously it was not clear from the documentation that configuration files are optional or why non-not-exist errors are hard errors. This change adds the information about these important properties of config files to the documentation.
  • Loading branch information
Kixunil authored Dec 3, 2023
1 parent b24fcae commit 0504b08
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ can lead to serious problems! Currently the *only* permitted operation is *delet
#### Configuration files and priorities

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`.
They are loaded if they *exist* and ignored if not however, to aid debugging, any other error when opening them such as permission error will make electrs exit with error.

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.
Expand Down

0 comments on commit 0504b08

Please sign in to comment.