Separate Indexer, Web App, and API

Blockscout supports several modes which run in a single all-in-one application by default.

Modes

It is possible to run modes separately or in different combinations. For example, you may want to run the indexer mode + API to create an indexed db with programmatic access and no UI, or indexer mode + UI to leverage Blockscout as a read-only explorer.

Note that the application is limited to 1 running indexer per 1 Blockscout instance. However, the indexer automatically reruns child processes within the Elixir architecture, making it quite fault-tolerant.

To run these modes separately, adjust ENV variables as follows:

Indexer mode

To run Blockscout in indexer mode, disable the web application and API:

export DISABLE_WEBAPP=true
export API_V1_READ_METHODS_DISABLED=true
export API_V1_WRITE_METHODS_DISABLED=true

Web application mode

To run Blockscout in web application mode only, disable the indexer and API read methods (API write functionality is not disabled to support smart contracts verification in the UI).

export DISABLE_INDEXER=true
export API_V1_READ_METHODS_DISABLED=true

API mode

To run in API mode, disable the indexer and webapp.

export DISABLE_INDEXER=true
export DISABLE_WEBAPP=true

Web UI + API mode

export DISABLE_INDEXER=true

Last updated

Was this helpful?