Indexer Configuration

Below you will find a list of CLI configuration options that can be used to configure either the Fuel Indexer service, the standalone Fuel Indexer GraphQL API service, or both. For those who prefer using a configuration file, you can checkout the default service configuration file, which also shows the default values used for these configuration options.

Usage:

Using the main Fuel Indexer service binary.

cargo run --bin fuel-indexer -- [options]

Using the standalone GraphQL API server.

cargo run --bin fuel-indexer-api-server -- [options]

Options:

-c --config

  • Path to the configuration file.

-m --manifest

  • Path to manifest file from which initial indices will be loaded

Fuel node: The node running the Fuel client implementation.

--fuel-node-host

  • IP of the Fuel node

--fuel-node-port

  • Port of the Fuel node

GraphQL API: The enpoint at which GraphQL queries will be processed. This is context dependent. If ran using the fuel-indexer binary, these options apply to the GraphQL service run in that binary. If ran using the fuel-indexer-api-server binary, these options will apply to that service.

--graphql-api-host

  • IP at which to bind the GraphQL server

--graphql-api-port

  • Port at which to bind the GraphQL server

  • --run-migrations

  • Whether to run the migrations on the GraphQL API's connected database

Postgres: Standard Postgres connection options.

--postgres-host

  • Postgres host

--postgres-port

  • Postgres port

--postgres-username

  • Postgres username

--postgres-password

  • Postgres password (redacted from logging)

--postgres-database

  • Postgres database

SQLite: An alternative database implementation using standard SQLite connection options

  • --sqlite-database

  • Path to SQLite database