465327c62d
This commit adds environment variable expansion and path cleaning to the data directory. This allows the user to specify data paths in the config file such as datadir=~/.btcd/data and datadir=$SOMEVAR/btcd. It also adds usage instructions and an example to the sample btcd.conf file.
88 lines
3.3 KiB
Text
88 lines
3.3 KiB
Text
[Application Options]
|
|
|
|
; ------------------------------------------------------------------------------
|
|
; Data settings
|
|
; ------------------------------------------------------------------------------
|
|
|
|
; The directory to store data such as the block chain and peer addresses. The
|
|
; block chain takes several GB, so this location must have a lot of free space.
|
|
; The default is ~/.btcd/data on POSIX OSes and $APPDATA/btcd/data on Windows.
|
|
; Environment variables are expanded so they may be used. NOTE: Windows
|
|
; environment variables are typically %VARIABLE%, but they must be accessed with
|
|
; $VARIABLE here. Also, ~ is expanded to $APPDATA on Windows.
|
|
; datadir=~/.btcd/data
|
|
|
|
|
|
; ------------------------------------------------------------------------------
|
|
; Network settings
|
|
; ------------------------------------------------------------------------------
|
|
|
|
; Use testnet.
|
|
; testnet=1
|
|
|
|
; Connect via a SOCKS5 proxy.
|
|
; proxy=127.0.0.1:9050
|
|
; proxyuser=
|
|
; proxypass=
|
|
|
|
; The SOCKS5 proxy above is Tor (https://www.torproject.org).
|
|
; Although not required if the proxy set is indeed Tor, setting this option
|
|
; does the following:
|
|
; - Sends DNS queries over the Tor network (during DNS seed lookup). This
|
|
; stops your IP from being leaked via DNS.
|
|
; - Does not disable the listening port. This allows the hidden services
|
|
; feature of Tor to be used.
|
|
; tor=1
|
|
|
|
|
|
; Add as many peers to connect to as desired. Separate each peer with a space.
|
|
; You may specify each IP address with or without a port. The default port will
|
|
; be added automatically if one is not specified here.
|
|
;
|
|
; NOTE: btcd only currently works with a single peer, but this will be changing
|
|
; soon as multi-peer support is under development.
|
|
; addpeer=192.168.1.1 10.0.0.2:8333 fe80::1 [fe80::2]:8333
|
|
|
|
; Maximum number of inbound and outbound peers.
|
|
; maxpeers=8
|
|
|
|
; How long to ban misbehaving peers. Valid time units are {s, m, h}.
|
|
; Minimum 1s.
|
|
; banduration=24h
|
|
; banduration=11h30m15s
|
|
|
|
|
|
; ------------------------------------------------------------------------------
|
|
; RPC server options - The following options control the built-in RPC server
|
|
; which is used to control and query information from a running btcd process.
|
|
;
|
|
; NOTE: The RPC server is disabled by default if no rpcuser or rpcpass is
|
|
; specified.
|
|
; ------------------------------------------------------------------------------
|
|
|
|
; Secure the RPC API by specifying the username and password. You must specify
|
|
; both or the RPC server will be disabled.
|
|
; rpcuser=whatever_username_you_want
|
|
; rpcpass=
|
|
|
|
; Use the following setting to disable the RPC server even if the rpcuser and
|
|
; rpcpass are specified above. This allows one to quickly disable the RPC
|
|
; server without having to remove credentials from the config file.
|
|
; norpc=1
|
|
|
|
; The port used to listen for RPC connections.
|
|
; rpcport=8332
|
|
|
|
|
|
; ------------------------------------------------------------------------------
|
|
; Debug
|
|
; ------------------------------------------------------------------------------
|
|
|
|
; Debug logging level.
|
|
; Valid options are {trace, debug, info, warn, error, critical}
|
|
; debuglevel=info
|
|
|
|
; The port used to listen for HTTP profile requests. The profile server will
|
|
; be disabled if this option is not specified. The profile information can be
|
|
; accessed at http://localhost:<profileport>/debug/pprof once running.
|
|
; profile=6061
|