ENV Variables
This table is horizontally scrollable, version information is located in the last column.
Additional information related to certain variables is available on the ansible deployment page.
You will find deprecated ENV vars in Deprecated ENV Variables chapter
To set variables using the CLI, use the export command. For example:
$ export ETHEREUM_JSONRPC_VARIANT=parity$ export COIN=POA$ export NETWORK=POA
Variable | Required | Description | Default | Version | Need recompile |
| ✅ | Environment variable for the main EVM network such as Ethereum or POA | POA | all | |
| ✅ | Environment variable for the subnetwork such as Core or Sokol Network. This will be displayed as selected in the chains list dropdown. | POA Sokol | all | |
| ✅ | Environment variable for the header logo image location. The logo files names for different chains can be found here | /images/blockscout_logo.svg | all | |
| ✅ | Environment variable for the footer logo image location. The logo files names for different chains can be found here | /images/blockscout_logo.svg | | |
| ✅ | Tells the application which RPC Client the node is using (i.e. | parity | all | |
| ✅ | The RPC endpoint used to fetch blocks, transactions, receipts, tokens. | localhost:8545 | all | |
| | The RPC endpoint specifically for the Geth/Parity/Besu client used by trace_block and trace_replayTransaction. This can be used to designate a tracing node. | localhost:8545 | all | |
| ✅ | The WebSockets RPC endpoint used to subscribe to the | ws://localhost:8546 | all | |
| | Specifies the transport for blockscout to connect to the Ethereum Node. Available transports are | http | v3.1.0+ | |
| | Path to the ipc file of the running node if IPC transport is chosen | (empty) | v2.1.1+ | |
| | Used to set a network path other than what is displayed in the root directory. An example would be to add | / | all | |
| | PATH in API endpoint URL at API docs page | / | v3.1.0+ | |
| | Custom websocket path | (empty) | v3.0.0+ | |
| | Host for API endpoint examples | localhost | v2.1.0+ | |
| | Url scheme for blockscout | in prod env | v2.1.0+ | |
| ✅ | Use mix phx.gen.secret to generate a new Secret Key Base string to protect production assets. | (empty) | all | |
| | Used to check the origin of requests when the origin header is present. It defaults to | false | all | |
| ✅ | Default port the application runs on is 4000 | 4000 | all | |
| ✅ | The coin here is checked via the CoinGecko API to obtain USD prices on graphs and other areas of the UI | POA | all | |
| | Explicitly set CoinGecko coin ID | (empty) | v3.1.2+ | |
| | This environment variable is specifically used by POA Network to obtain Validators information to display in the UI. | (empty) | all | |
| | This environment variable is specifically used by POA Network to obtain the list of current validators. | (empty) | all | |
| | This environment variable is specifically used by POA Network to set KeysManager proxy contract in order to obtain payout key by mining key. This need to identify distributed reward to validator. | (empty) | v3.1.2+ | |
| | Emission rewards contract address. This env var is used only if |
| v2.0.4+ | |
| | Token bridge proxy contract. For `TokenBridge` supply module. |
| v1.3.2+ | |
| | Should be set to |
| v2.0.4+ | |
| | Chain specification path (absolute file system path or url) to import block emission reward ranges and genesis account balances from. Geth- and Parity-style specs are supported. | (empty) | v2.0.4+ | |
| | This environment variable is used by the xDai Chain/RSK in order to tell the application how to calculate the total supply of the chain. Available values are | (empty) | all | |
| | This environment variable is used to calculate the exchange rate and is specifically used by the xDai Chain. Available value is | (empty) | all | |
| ✅ | Variable to define the Database endpoint. | (empty) | all | |
| | Production environment variable to define the number of database connections allowed. | 20 | all | |
| | Production environment variable to use SSL on Ecto queries. | true | all | |
| | Host configuration setting for Datadog integration | (empty) | all | |
| | Port configuration setting for Datadog integration. | (empty} | all | |
| | Spandex and Datadog configuration setting. | (empty) | all | |
| | Spandex and Datadog configuration setting. | (empty) | all | |
| | Production environment variable to restart the application in the event of a crash. | 30 | all | |
| | Production environment variable to restart the application in the event of a crash. | systemctl restart explorer.service | all | |
| | Added to the footer to signify the current BlockScout version. | (empty) | v1.3.4+ | |
| | The link to Blockscout release notes in the footer. | https: //github.com/poanetwork/ blockscout/releases/ tag/${BLOCKSCOUT_VERSION} | v1.3.5+ | |
| | Elixir version to install on the node before Blockscout deploy. It is used in bash script in Terraform / Ansible deployment script | (empty) | all | |
| | Transformer for blocks: base or clique. | base | v1.3.4+ | |
| | Default transaction hash in a sample query to GraphiQL. | (empty) | v1.2.0+ | ✅ |
| | The block number, where indexing begins from. | 0 | v1.3.8+ | |
| | The block number, where indexing stops. | (empty) | v2.0.3+ | |
| | true/false. If true, links to other explorers are added in the footer | (empty) | v1.3.0+ | |
| | Array of supported chains that displays in the footer and in the chains dropdown. This var was introduced in this PR #1900 and looks like an array of JSON objects. | (empty) | v2.0.0+ | |
| | time to live of blocks with consensus count cache in seconds. This var was introduced in #1876 | 600 | v2.0.0+ | |
| | Interval in seconds to restart the task, which calculates the total txs count. | 60 * 60 * 2 | v1.3.9+ | |
| | time to live of cache in seconds. This var was introduced in #2822 | 60 * 60 * 2 | v2.1.1+ | |
| | time to live of addresses sum (except burn address) cache in seconds. This var was introduced in #2862 | 3600 | v2.1.1+ | |
| | Interval in seconds to restart the task, which calculates addresses with balances. | 30 * 60 | v1.3.9+ | |
| | Interval in seconds to restart the task which updates token metadata | 60 * 60 * 24 * 2 | v2.0.1+ | |
| | Update of average block period cache, in seconds | 30 minutes | v2.0.2+ | |
| | Update of market history cache, in seconds | 6 hours | v2.0.2+ | |
| | the comma-separated list of allowed EVM versions for contracts verification. This var was introduced in #1964 | "homestead, tangerineWhistle, spuriousDragon, byzantium, constantinople, petersburg" | v2.0.0+ | |
| | Include or exclude non-consensus blocks in avg block time calculation. Exclude if | false | v2.0.1+ | |
| | If |
| v2.0.3+ | ✅ |
| | If |
| v2.0.3+ | ✅ |
| | If |
| v2.0.3+ | ✅ |
| | If |
| v2.0.3+ | ✅ |
| | Link to web application instance, e.g. | (empty) | v2.0.3+ | |
| | Link to API instance, e.g. | (empty) | v2.0.3+ | |
| | If | (empty) | v3.3.2+ | ✅ |
| | Configures market cap percentage column on the top accounts page |
| v2.1.1+ | |
| | If set to | true | v3.1.0+ | |
| | Defines checksum address function. 2 available values: | eth | v2.0.1+ | |
| | Disables or enables fetching of coin price from Coingecko API | false | v3.1.2+ | |
| | Disables or enables txs per day stats gathering | false | v3.1.2+ | |
| | Disables or enables price and market cap of coin charts on the main page | false | v3.1.2+ | |
| | Disables or enables txs count per day chart on the main page | false | v3.1.2+ | |
| | Interval in minutes how often to request count of txs per current day in order to display txs count per day chart on the main page | 60 | v3.1.2+ | |
| | The initial delay in minutes in txs count history fetching in order to display txs count per day history chart on the main page | 0 | v3.1.2+ | |
| | Number of days for fetching of history of txs count per day in order to display it in txs count per day history chart on the main page | 365 | v3.1.2+ | |
| | Number of days to consider at coin balance history chart | 10 | v3.1.3+ | |
| | true/false. If true, Apps navigation menu item appears | false | v3.3.1+ | |
| | An array of external apps to display in Apps menu item. This var was introduced in this PR #3184 and looks like an array of JSON objects. | (empty) | v3.3.1+ | |
| | An address of AMB mediator for multi tokens. Providing this address enables bridged tokens functionality: bridged status and link to the original token in the foreign chain. | (empty) | v3.3.2+ | |
| | Gas price in Gwei. If the variable is present, gas price displays at the main page | (empty) | v3.3.2+ | |
| | JSON RPC endpoint to the foreign chain in order to get metadata of bridged through Omni-bridge token. It was introduced in this PR #3282 | (empty) | master | |
| | Market cap update interval for `TokenBridge` supply module as for TokenBridge and for OmniBridge as well, in seconds. It was introduced in this PR #3293 | 30 minutes | master | |
| | A comma-separated list of addresses to enable restricted access on them | (empty) | master | |
| | A key to access addresses listed in | (empty) | master | |
