Skip to content

Commit 3eac2d5

Browse files
Csi18nAlistairMannfanquake
authored andcommitted
docs: add "sections" info to example bitcoin.conf
Most bitcoin.conf options apply to all three networks, however some apply only to mainnet unless specified in a section. As stands, conf file has no indication that sections are now in use or are in some circumstances mandatory (eg, changing rpcport for testnet.) Proposed change notifies the reader early which options are affected, specifically adds those options affected but not already in the example, adds brief explanation as to what's going on and provides a skeleton template for the sections themselves.
1 parent 37f236a commit 3eac2d5

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

share/examples/bitcoin.conf

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
# Network-related settings:
66

7+
# Note that if you use testnet or regtest, particularly with the options
8+
# addnode, connect, port, bind, rpcport, rpcbind or wallet, you will also
9+
# want to read "[Sections]" further down.
10+
711
# Run on the test network instead of the real bitcoin network.
812
#testnet=0
913

@@ -53,6 +57,9 @@
5357
# Listening mode, enabled by default except when 'connect' is being used
5458
#listen=1
5559

60+
# Port on which to listen for connections (default: 8333, testnet: 18333, regtest: 18444)
61+
#port=
62+
5663
# Maximum number of inbound+outbound connections.
5764
#maxconnections=
5865

@@ -115,6 +122,10 @@
115122

116123
# Wallet options
117124

125+
# Specify where to find wallet, lockfile and logs. If not present, those files will be
126+
# created as new.
127+
#wallet=</path/to/dir>
128+
118129
# Create transactions that have enough fees so they are likely to begin confirmation within n blocks (default: 6).
119130
# This setting is over-ridden by the -paytxfee option.
120131
#txconfirmtarget=n
@@ -142,3 +153,19 @@
142153

143154
# Minimize to the system tray
144155
#minimizetotray=1
156+
157+
# [Sections]
158+
# Most options apply to mainnet, testnet and regtest.
159+
# If you want to confine an option to just one network, you should add it in the
160+
# relevant section below.
161+
# EXCEPTIONS: The options addnode, connect, port, bind, rpcport, rpcbind and wallet
162+
# only apply to mainnet unless they appear in the appropriate section below.
163+
164+
# Options only for mainnet
165+
[main]
166+
167+
# Options only for testnet
168+
[test]
169+
170+
# Options only for regtest
171+
[regtest]

0 commit comments

Comments
 (0)