2.0 KiB
Environment variables
Some behavior of Blockbook can be modified by environment variables. The variables usually start with a coin shortcut to allow to run multiple Blockbooks on a single server.
-
<coin shortcut>_WS_GETACCOUNTINFO_LIMIT- Limits the number ofgetAccountInforequests per websocket connection to reduce server abuse. Accepts number as input. -
<coin shortcut>_STAKING_POOL_CONTRACT- The pool name and contract used for Ethereum staking. The format of the variable is<pool name>/<pool contract>. If missing, staking support is disabled. -
COINGECKO_API_KEY,<network>_COINGECKO_API_KEY, or<coin shortcut>_COINGECKO_API_KEY- API key for making requests to CoinGecko in the paid tier. If any of these variables is set, it must be non-empty (empty value is treated as a configuration error and Blockbook fails on startup). Lookup priority is:<network>_COINGECKO_API_KEY<coin shortcut>_COINGECKO_API_KEYCOINGECKO_API_KEYExample: for Optimism,network=OPandcoin shortcut=ETH, soOP_COINGECKO_API_KEYis preferred overETH_COINGECKO_API_KEY.
-
<coin shortcut>_ALLOWED_RPC_CALL_TO- Addresses to whichrpcCallwebsocket requests can be made, as a comma-separated list. If omitted,rpcCallis enabled for all addresses.
Build-time variables
BB_RPC_URL_HTTP_<coin alias>- Overridesipc.rpc_url_templateduring package/config generation so build and integration-test tooling can target hosted HTTP RPC endpoints without editing coin JSON.BB_RPC_URL_WS_<coin alias>- Overridesipc.rpc_url_ws_templatefor WebSocket subscriptions; should point to the same host asBB_RPC_URL_HTTP_<coin alias>.BB_RPC_BIND_HOST_<coin alias>- Overrides backend RPC bind host during package/config generation; when set to0.0.0.0, RPC stays restricted unlessBB_RPC_ALLOW_IP_<coin alias>is set.BB_RPC_ALLOW_IP_<coin alias>- Overrides backend RPC allow list for UTXO configs (e.g.rpcallowip), defaulting to127.0.0.1.