From 3195020feefcf3ae575abc6bb76fbba57da16956 Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Wed, 7 Aug 2013 12:12:46 -0500 Subject: [PATCH] Improve sample-btcd.conf. This commit improves the sample-btcd.conf file by including some explanatory text and adding a few more available options. --- btcd/config.go | 4 ++-- btcd/sample-btcd.conf | 49 ++++++++++++++++++++++++++++++++++++------- 2 files changed, 43 insertions(+), 10 deletions(-) diff --git a/btcd/config.go b/btcd/config.go index e8e42aba..b7be3f36 100644 --- a/btcd/config.go +++ b/btcd/config.go @@ -38,7 +38,6 @@ type config struct { ConnectPeers []string `long:"connect" description:"Connect only to the specified peers at startup"` SeedPeer string `short:"s" long:"seedpeer" description:"Retrieve peer addresses from this peer and then disconnect"` Port string `short:"p" long:"port" description:"Listen for connections on this port (default: 8333, testnet: 18333)"` - RpcPort string `short:"r" long:"rpcport" description:"Listen for json/rpc messages on this port"` MaxPeers int `long:"maxpeers" description:"Max number of inbound and outbound peers"` BanDuration time.Duration `long:"banduration" description:"How long to ban misbehaving peers. Valid time units are {s, m, h}. Minimum 1 second"` VerifyDisabled bool `long:"noverify" description:"Disable block/transaction verification -- WARNING: This option can be dangerous and is for development use only"` @@ -46,7 +45,8 @@ type config struct { DbDir string `short:"b" long:"dbdir" description:"Directory to store database"` RpcUser string `short:"u" long:"rpcuser" description:"Username for rpc connections"` RpcPass string `short:"P" long:"rpcpass" description:"Password for rpc connections"` - DisableRpc bool `long:"norpc" description:"Disable built-in RPC server"` + RpcPort string `short:"r" long:"rpcport" description:"Listen for json/rpc messages on this port"` + DisableRpc bool `long:"norpc" description:"Disable built-in RPC server -- NOTE: The RPC server is disabled by default if no rpcuser/rpcpass is specified"` DisableDNSSeed bool `long:"nodnsseed" description:"Disable DNS seeding for peers"` TestNet3 bool `long:"testnet" description:"Use the test network"` RegressionTest bool `long:"regtest" description:"Use the regression test network"` diff --git a/btcd/sample-btcd.conf b/btcd/sample-btcd.conf index 9c6f00c9..13e435bb 100644 --- a/btcd/sample-btcd.conf +++ b/btcd/sample-btcd.conf @@ -1,16 +1,18 @@ [Application Options] -; Debug logging level. -; Valid options are {trace, debug, info, warn, error, critical} -; debuglevel=info + +; ------------------------------------------------------------------------------ +; Network settings +; ------------------------------------------------------------------------------ ; Use testnet. ; testnet=1 -; Add as many specific space separated peers to connect to as desired. -; addpeer=192.168.1.1 -; addpeer=10.0.0.2:8333 -; addpeer=fe80::1 -; addpeer=[fe80::2]:8333 +; 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. @@ -20,3 +22,34 @@ ; 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