Skip to content

Commit b483084

Browse files
committed
doc: replace bitcoin.conf with placeholder file
1 parent 91a6736 commit b483084

File tree

1 file changed

+1
-191
lines changed

1 file changed

+1
-191
lines changed

share/examples/bitcoin.conf

+1-191
Original file line numberDiff line numberDiff line change
@@ -1,191 +1 @@
1-
##
2-
## bitcoin.conf configuration file. Lines beginning with # are comments.
3-
##
4-
5-
# Network-related settings:
6-
7-
# Note that if you use testnet, signet 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-
11-
# Run on the testnet network
12-
#testnet=0
13-
14-
# Run on a signet network
15-
#signet=0
16-
17-
# Run a regression test network
18-
#regtest=0
19-
20-
# Connect via a SOCKS5 proxy
21-
#proxy=127.0.0.1:9050
22-
23-
# Bind to given address and always listen on it. Use [host]:port notation for IPv6
24-
#bind=<addr>
25-
26-
# Bind to given address and add permission flags to peers connecting to it. Use [host]:port notation for IPv6
27-
#whitebind=perm@<addr>
28-
29-
##############################################################
30-
## Quick Primer on addnode vs connect ##
31-
## Let's say for instance you use addnode=4.2.2.4 ##
32-
## addnode will connect you to and tell you about the ##
33-
## nodes connected to 4.2.2.4. In addition it will tell ##
34-
## the other nodes connected to it that you exist so ##
35-
## they can connect to you. ##
36-
## connect will not do the above when you 'connect' to it. ##
37-
## It will *only* connect you to 4.2.2.4 and no one else.##
38-
## ##
39-
## So if you're behind a firewall, or have other problems ##
40-
## finding nodes, add some using 'addnode'. ##
41-
## ##
42-
## If you want to stay private, use 'connect' to only ##
43-
## connect to "trusted" nodes. ##
44-
## ##
45-
## If you run multiple nodes on a LAN, there's no need for ##
46-
## all of them to open lots of connections. Instead ##
47-
## 'connect' them all to one node that is port forwarded ##
48-
## and has lots of connections. ##
49-
## Thanks goes to [Noodle] on Freenode. ##
50-
##############################################################
51-
52-
# Use as many addnode= settings as you like to connect to specific peers
53-
#addnode=69.164.218.197
54-
#addnode=10.0.0.2:8333
55-
56-
# Alternatively use as many connect= settings as you like to connect ONLY to specific peers
57-
#connect=69.164.218.197
58-
#connect=10.0.0.1:8333
59-
60-
# Listening mode, enabled by default except when 'connect' is being used
61-
#listen=1
62-
63-
# Port on which to listen for connections (default: 8333, testnet: 18333, signet: 38333, regtest: 18444)
64-
#port=
65-
66-
# Maximum number of inbound + outbound connections (default: 125). This option
67-
# applies only if inbound connections are enabled; otherwise, the number of connections
68-
# will not be more than 11: 8 full-relay connections, 2 block-relay-only ones, and
69-
# occasionally 1 short-lived feeler or extra outbound block-relay-only connection.
70-
# These limits do not apply to connections added manually with the -addnode
71-
# configuration option or the addnode RPC, which have a separate limit of 8 connections.
72-
#maxconnections=
73-
74-
# Maximum upload bandwidth target in MiB per day (e.g. 'maxuploadtarget=1024' is 1 GiB per day).
75-
# This limits the upload bandwidth for those with bandwidth limits. 0 = no limit (default: 0).
76-
# -maxuploadtarget does not apply to peers with 'download' permission.
77-
# For more information on reducing bandwidth utilization, see: doc/reduce-traffic.md.
78-
#maxuploadtarget=
79-
80-
#
81-
# JSON-RPC options (for controlling a running Bitcoin/bitcoind process)
82-
#
83-
84-
# server=1 tells Bitcoin-Qt and bitcoind to accept JSON-RPC commands
85-
#server=0
86-
87-
# Bind to given address to listen for JSON-RPC connections.
88-
# Refer to the manpage or bitcoind -help for further details.
89-
#rpcbind=<addr>
90-
91-
# If no rpcpassword is set, rpc cookie auth is sought. The default `-rpccookiefile` name
92-
# is .cookie and found in the `-datadir` being used for bitcoind. This option is typically used
93-
# when the server and client are run as the same user.
94-
#
95-
# If not, you must set rpcuser and rpcpassword to secure the JSON-RPC API.
96-
#
97-
# The config option `rpcauth` can be added to server startup argument. It is set at initialization time
98-
# using the output from the script in share/rpcauth/rpcauth.py after providing a username:
99-
#
100-
# ./share/rpcauth/rpcauth.py alice
101-
# String to be appended to bitcoin.conf:
102-
# rpcauth=alice:f7efda5c189b999524f151318c0c86$d5b51b3beffbc02b724e5d095828e0bc8b2456e9ac8757ae3211a5d9b16a22ae
103-
# Your password:
104-
# DONT_USE_THIS_YOU_WILL_GET_ROBBED_8ak1gI25KFTvjovL3gAM967mies3E=
105-
#
106-
# On client-side, you add the normal user/password pair to send commands:
107-
#rpcuser=alice
108-
#rpcpassword=DONT_USE_THIS_YOU_WILL_GET_ROBBED_8ak1gI25KFTvjovL3gAM967mies3E=
109-
#
110-
# You can even add multiple entries of these to the server conf file, and client can use any of them:
111-
# rpcauth=bob:b2dd077cb54591a2f3139e69a897ac$4e71f08d48b4347cf8eff3815c0e25ae2e9a4340474079f55705f40574f4ec99
112-
113-
# How many seconds bitcoin will wait for a complete RPC HTTP request.
114-
# after the HTTP connection is established.
115-
#rpcclienttimeout=30
116-
117-
# By default, only RPC connections from localhost are allowed.
118-
# Specify as many rpcallowip= settings as you like to allow connections from other hosts,
119-
# either as a single IPv4/IPv6 or with a subnet specification.
120-
121-
# NOTE: opening up the RPC port to hosts outside your local trusted network is NOT RECOMMENDED,
122-
# because the rpcpassword is transmitted over the network unencrypted.
123-
124-
# server=1 tells Bitcoin-Qt to accept JSON-RPC commands.
125-
# it is also read by bitcoind to determine if RPC should be enabled
126-
#rpcallowip=10.1.1.34/255.255.255.0
127-
#rpcallowip=1.2.3.4/24
128-
#rpcallowip=2001:db8:85a3:0:0:8a2e:370:7334/96
129-
130-
# Listen for RPC connections on this TCP port:
131-
#rpcport=8332
132-
133-
# You can use Bitcoin or bitcoind to send commands to Bitcoin/bitcoind
134-
# running on another host using this option:
135-
#rpcconnect=127.0.0.1
136-
137-
# Wallet options
138-
139-
# Specify where to find wallet, lockfile and logs. If not present, those files will be
140-
# created as new.
141-
#wallet=</path/to/dir>
142-
143-
# Create transactions that have enough fees so they are likely to begin confirmation within n blocks (default: 6).
144-
# This setting is over-ridden by the -paytxfee option.
145-
#txconfirmtarget=n
146-
147-
# Pay a transaction fee every time you send bitcoins.
148-
#paytxfee=0.000x
149-
150-
# Miscellaneous options
151-
152-
# Pre-generate this many public/private key pairs, so wallet backups will be valid for
153-
# both prior transactions and several dozen future transactions.
154-
#keypool=100
155-
156-
# Maintain coinstats index used by the gettxoutsetinfo RPC (default: 0).
157-
#coinstatsindex=1
158-
159-
# Enable pruning to reduce storage requirements by deleting old blocks.
160-
# This mode is incompatible with -txindex and -coinstatsindex.
161-
# 0 = default (no pruning).
162-
# 1 = allows manual pruning via RPC.
163-
# >=550 = target to stay under in MiB.
164-
#prune=550
165-
166-
# User interface options
167-
168-
# Start Bitcoin minimized
169-
#min=1
170-
171-
# Minimize to the system tray
172-
#minimizetotray=1
173-
174-
# [Sections]
175-
# Most options apply to mainnet, testnet, signet and regtest.
176-
# If you want to confine an option to just one network, you should add it in the
177-
# relevant section below.
178-
# EXCEPTIONS: The options addnode, connect, port, bind, rpcport, rpcbind and wallet
179-
# only apply to mainnet unless they appear in the appropriate section below.
180-
181-
# Options only for mainnet
182-
[main]
183-
184-
# Options only for testnet
185-
[test]
186-
187-
# Options only for signet
188-
[signet]
189-
190-
# Options only for regtest
191-
[regtest]
1+
# This is a placeholder file. Please follow the instructions in `contrib/devtools/README.md` to generate a bitcoin.conf file.

0 commit comments

Comments
 (0)