doc: spelling fixes
[bitcoinplatinum.git] / contrib / debian / examples / bitcoin.conf
blob14a59fdf6bc8b58e3bc3e6720548a12fa6ea3b88
1 ##
2 ## bitcoin.conf configuration file. Lines beginning with # are comments.
3 ##
4  
5 # Network-related settings:
7 # Run on the test network instead of the real bitcoin network.
8 #testnet=0
10 # Run a regression test network
11 #regtest=0
13 # Connect via a SOCKS5 proxy
14 #proxy=127.0.0.1:9050
16 # Bind to given address and always listen on it. Use [host]:port notation for IPv6
17 #bind=<addr>
19 # Bind to given address and whitelist peers connecting to it. Use [host]:port notation for IPv6
20 #whitebind=<addr>
22 ##############################################################
23 ##            Quick Primer on addnode vs connect            ##
24 ##  Let's say for instance you use addnode=4.2.2.4          ##
25 ##  addnode will connect you to and tell you about the      ##
26 ##    nodes connected to 4.2.2.4.  In addition it will tell ##
27 ##    the other nodes connected to it that you exist so     ##
28 ##    they can connect to you.                              ##
29 ##  connect will not do the above when you 'connect' to it. ##
30 ##    It will *only* connect you to 4.2.2.4 and no one else.##
31 ##                                                          ##
32 ##  So if you're behind a firewall, or have other problems  ##
33 ##  finding nodes, add some using 'addnode'.                ##
34 ##                                                          ##
35 ##  If you want to stay private, use 'connect' to only      ##
36 ##  connect to "trusted" nodes.                             ##
37 ##                                                          ##
38 ##  If you run multiple nodes on a LAN, there's no need for ##
39 ##  all of them to open lots of connections.  Instead       ##
40 ##  'connect' them all to one node that is port forwarded   ##
41 ##  and has lots of connections.                            ##
42 ##       Thanks goes to [Noodle] on Freenode.               ##
43 ##############################################################
45 # Use as many addnode= settings as you like to connect to specific peers
46 #addnode=69.164.218.197
47 #addnode=10.0.0.2:8333
49 # Alternatively use as many connect= settings as you like to connect ONLY to specific peers
50 #connect=69.164.218.197
51 #connect=10.0.0.1:8333
53 # Listening mode, enabled by default except when 'connect' is being used
54 #listen=1
56 # Maximum number of inbound+outbound connections.
57 #maxconnections=
60 # JSON-RPC options (for controlling a running Bitcoin/bitcoind process)
63 # server=1 tells Bitcoin-Qt and bitcoind to accept JSON-RPC commands
64 #server=0
66 # Bind to given address to listen for JSON-RPC connections. Use [host]:port notation for IPv6.
67 # This option can be specified multiple times (default: bind to all interfaces)
68 #rpcbind=<addr>
70 # If no rpcpassword is set, rpc cookie auth is sought. The default `-rpccookiefile` name
71 # is .cookie and found in the `-datadir` being used for bitcoind. This option is typically used
72 # when the server and client are run as the same user.
74 # If not, you must set rpcuser and rpcpassword to secure the JSON-RPC api. The first
75 # method(DEPRECATED) is to set this pair for the server and client:
76 #rpcuser=Ulysseys
77 #rpcpassword=YourSuperGreatPasswordNumber_DO_NOT_USE_THIS_OR_YOU_WILL_GET_ROBBED_385593
79 # The second method `rpcauth` can be added to server startup argument. It is set at initialization time
80 # using the output from the script in share/rpcuser/rpcuser.py after providing a username:
82 # ./share/rpcuser/rpcuser.py alice
83 # String to be appended to bitcoin.conf:
84 # rpcauth=alice:f7efda5c189b999524f151318c0c86$d5b51b3beffbc02b724e5d095828e0bc8b2456e9ac8757ae3211a5d9b16a22ae
85 # Your password:
86 # DONT_USE_THIS_YOU_WILL_GET_ROBBED_8ak1gI25KFTvjovL3gAM967mies3E=
88 # On client-side, you add the normal user/password pair to send commands:
89 #rpcuser=alice
90 #rpcpassword=DONT_USE_THIS_YOU_WILL_GET_ROBBED_8ak1gI25KFTvjovL3gAM967mies3E=
92 # You can even add multiple entries of these to the server conf file, and client can use any of them:
93 # rpcauth=bob:b2dd077cb54591a2f3139e69a897ac$4e71f08d48b4347cf8eff3815c0e25ae2e9a4340474079f55705f40574f4ec99
95 # How many seconds bitcoin will wait for a complete RPC HTTP request.
96 # after the HTTP connection is established. 
97 #rpcclienttimeout=30
99 # By default, only RPC connections from localhost are allowed.
100 # Specify as many rpcallowip= settings as you like to allow connections from other hosts,
101 # either as a single IPv4/IPv6 or with a subnet specification.
103 # NOTE: opening up the RPC port to hosts outside your local trusted network is NOT RECOMMENDED,
104 # because the rpcpassword is transmitted over the network unencrypted.
106 # server=1 tells Bitcoin-Qt to accept JSON-RPC commands.
107 # it is also read by bitcoind to determine if RPC should be enabled 
108 #rpcallowip=10.1.1.34/255.255.255.0
109 #rpcallowip=1.2.3.4/24
110 #rpcallowip=2001:db8:85a3:0:0:8a2e:370:7334/96
112 # Listen for RPC connections on this TCP port:
113 #rpcport=8332
115 # You can use Bitcoin or bitcoind to send commands to Bitcoin/bitcoind
116 # running on another host using this option:
117 #rpcconnect=127.0.0.1
119 # Create transactions that have enough fees so they are likely to begin confirmation within n blocks (default: 6).
120 # This setting is over-ridden by the -paytxfee option.
121 #txconfirmtarget=n
123 # Miscellaneous options
125 # Pre-generate this many public/private key pairs, so wallet backups will be valid for
126 # both prior transactions and several dozen future transactions.
127 #keypool=100
129 # Pay an optional transaction fee every time you send bitcoins.  Transactions with fees
130 # are more likely than free transactions to be included in generated blocks, so may
131 # be validated sooner.
132 #paytxfee=0.00
134 # Enable pruning to reduce storage requirements by deleting old blocks. 
135 # This mode is incompatible with -txindex and -rescan.
136 # 0 = default (no pruning).
137 # 1 = allows manual pruning via RPC.
138 # >=550 = target to stay under in MiB. 
139 #prune=550
141 # User interface options
143 # Start Bitcoin minimized
144 #min=1
146 # Minimize to the system tray
147 #minimizetotray=1