BitGo Express

Reference Configuration Parameters

BitGo Express is able to use following configuration parameters from either command-line arguments or environment variables.

Flag Short Name Flag Long Name Environment Variable Default Value Description
-p --port BITGO_PORT 3080 Port that bitgo express listens on.
-b --bind BITGO_BIND localhost Interface that bitgo express listens on. To listen on all interfaces, set to 0.0.0.0.
-e --env BITGO_ENV test BitGo environment to interact with.
-t --timeout BITGO_TIMEOUT 305000 Number of milliseconds to wait before requests made by bitgo-express time out.
-d --debug N/A, use BITGO_DEBUG_NAMESPACE instead N/A Enables debug output for bitgo-express. This is equivalent to passing --debugnamespace bitgo:express.
-D --debugnamespace BITGO_DEBUG_NAMESPACE N/A Enables debug output for a particular debug namespace. Multiple debug namespaces can be given as a comma separated list. See the bitgo package README for a complete list of recognized options (in addition to the options listed in this table).
-k --keypath BITGO_KEYPATH N/A Path to SSL .key file. Required if running in live environment.
-c --crtpath BITGO_CRTPATH N/A Path to SSL .crt file. Required if running in live environment.
-u --customrooturi BITGO_CUSTOM_ROOT_URI N/A Forces a custom BitGo URI.
-n --custombitcoinnetwork BITGO_CUSTOM_BITCOIN_NETWORK N/A Forces a custom BitGo network.
-l --logfile BITGO_LOGFILE N/A Filepath to write access logs.
N/A --disablessl BITGO_DISABLE_SSL 0 N/A Disables requiring SSL when accessing the live environment. Note: Use at your own risk. We don't recommend.
N/A --disableproxy BITGO_DISABLE_PROXY 0 N/A Disables proxying of routes not explicitly handled by BitGo Express.
N/A --disableenvcheck BITGO_DISABLE_ENV_CHECK 0 N/A Disables checking for correct NODE_ENV environment variable when running in the live environment.
-i --ipc BITGO_IPC N/A If set, bind to the given IPC (unix domain) socket. Binding to an IPC socket can be useful if the caller of BitGo Express resides on the same host as the BitGo Express instance itself, since the socket can be secured using normal file permissions and ownership semantics. Note: This is not supported on Windows platforms.
N/A --authversion BITGO_AUTH_VERSION 2 BitGo authentication scheme version that's used for making requests to the BitGo server. For more information on authentication scheme version, see API Reference.
N/A --externalSignerUrl BITGO_EXTERNAL_SIGNER_URL N/A URL that specifies the external API to call for remote signing.
N/A --signerMode BITGO_SIGNER_MODE N/A If true, runs BitGo Express as a remote signer.
N/A --signerFileSystemPath BITGO_SIGNER_FILE_SYSTEM_PATH N/A Local path specifying where a BitGo Express signer machine keeps the encrypted private keys. Required if signerMode is true.
N/A ETHERSCAN_API_TOKEN N/A Etherscan API token required for the /{coin}/wallet/{walletId}/recovertoken express endpoint when recovering tokens on Ethereum-based networks. Also recommended in case of Etherscan rate limit reached. Create an API key from https://etherscan.io/apidashboard.

For backwards compatibility on some options, BitGo checks for the following deprecated environment variables:

Flag Short Name Flag Long Name Environment Variable Default Value Description
BITGO_DISABLESSL Disables SSL.
DISABLESSL Disables SSL.
DISABLE_ENV_CHECK Disables environment check.
DISABLE_PROXY Disables proxy.
DISABLE_SSL Disables SSL.