Configuration Settings

Specifying a Configuration File

Not all BX commands use configuration settings, in fact most do not. However all commands process the configuration file if its path is specified.

All commands accept a --config option. This allows any command line to specify a configuration file for use in that single execution.

If the --config option is not set the command will use the configuration file specified by the BX_CONFIG environment variable.

If neither the --config option nor the BX_CONFIG environment variable is set the command will use embedded default configuration settings. There is no default configuration file location.

Default Configuration Settings

The BX metadata file declares all valid configuration settings, their data types and descriptions. These values generated code that is used to build BX.

For convenience, the example.cfg file is also populated with these values, although the metadata file is authoritative.

# Bitcoin Explorer (BX) configuration file.

[general]
# Only hd-new and stealth-encode currently use the testnet distinction, apart from swapping servers.
# The network to use, either 'mainnet' or 'testnet'. Defaults to 'mainnet'.
network = mainnet
# Number of times to retry contacting the server before giving up.
retries = 0
# Milliseconds to wait for a response from the server.
wait = 2000

[logging]
# The path to the debug log file, used by send-tx-p2p.
debug = debug.log
# The path to the error log file, used by send-tx-p2p.
error = error.log

[mainnet]
# The URL of the default mainnet Obelisk server.
url = tcp://obelisk.airbitz.co:9091
# The server's base64-encoded public certificate.
#public = 
# The client's base64-encoded private certificate.
#private = 

[testnet]
# The URL of the default testnet Obelisk server.
url = tcp://obelisk-testnet.airbitz.co:9091
# The server's base64-encoded public certificate.
#public = 
# The client's base64-encoded private certificate.
#private = 

The file is not strictly an ini file although it is similar in structure. It is based on Boost program options.

Exporting Settings

The settings command outputs all settings and values. When a path is specified on the command line or by environment variable, the values are populated accordingly.