diff options
| author | Josiah Baker <josibake@protonmail.com> | 2021-06-17 16:36:08 +0200 |
|---|---|---|
| committer | josibake <josibake@protonmail.com> | 2022-05-02 15:56:49 +0200 |
| commit | 6aac946f49aea243de1dc50631bb72f0186bbf58 (patch) | |
| tree | 682df91390e08f9c2f437f2a713e3f7ba94bfdda /doc/bitcoin-conf.md | |
| parent | 1c7e820ded0846ef6ab4be9616b0de452336ef64 (diff) | |
doc: update bitcoin-conf.md
include instructions on how to run the script
Diffstat (limited to 'doc/bitcoin-conf.md')
| -rw-r--r-- | doc/bitcoin-conf.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/bitcoin-conf.md b/doc/bitcoin-conf.md index 8c9035c45b..acd767f234 100644 --- a/doc/bitcoin-conf.md +++ b/doc/bitcoin-conf.md @@ -61,4 +61,12 @@ Windows | `%APPDATA%\Bitcoin\` | `C:\Users\username\AppData\Roaming\Bitcoin\bitc Linux | `$HOME/.bitcoin/` | `/home/username/.bitcoin/bitcoin.conf` macOS | `$HOME/Library/Application Support/Bitcoin/` | `/Users/username/Library/Application Support/Bitcoin/bitcoin.conf` -You can find an example bitcoin.conf file in [share/examples/bitcoin.conf](../share/examples/bitcoin.conf). +An example configuration file can be generated by [contrib/devtools/gen-bitcoin-conf.sh](../contrib/devtools/gen-bitcoin-conf.sh). +Run this script after compiling to generate an up-to-date configuration file. +The output is placed under `share/examples/bitcoin.conf`. +To use the generated configuration file, copy the example file into your data directory and edit it there, like so: + +``` +# example copy command for linux user +cp share/examples/bitcoin.conf ~/.bitcoin +``` |