Configuration

ENVs

ALLOW_INTROSPECTION=true

Exposes the full schema to all clients, enabling tools such as the GraphQL Playground to display the schema as documentation. Not suggested for most production instances, and cannot be used in combination with the operation allow list.

ALLOW_LIST_PATH: String

Path to an allow-list generated by persistgraphql. Not compatible with ALLOW_INTROSPECTION

ALLOWED_ORIGINS: string | RegExp | (string | RegExp)[]

See CORS for more info

API_PORT: Number

Default: 3100

CACHE_ENABLED=true

Cache hits on specific resolvers. This enables a sensible configuration, however may become more flexible in the future.

CARDANO_CLI_PATH

Path to the cardano-cli binary

CARDANO_NODE_SOCKET_PATH

Path to the cardano-node socket

ENGINE_API_KEY: String

For use with Apollo Platform, or other compatible service to receive query traces.

GENESIS_FILE_BYRON

Path the the network's Byron genesis file

GENESIS_FILE_SHELLEY

Path to the network's Shelley genesis file

HASURA_URI

Hasura GraphQL server endpoint eg http://localhost:8090

HASURA_CLI_PATH

Path to the hasura binary.

JQ_PATH

Path to the jq binary

LISTEN_ADDRESS

Network address for the GraphQL server.

LOGGER_MIN_SEVERITY

trace | debug | info - default | warn | error | fatal

POLLING_INTERVAL_ADA_SUPPLY

Number of seconds between refreshing the circulating supply value cache. Default is 60 seconds

POSTGRES_HOST

Database host

POSTGRES_PORT

Database port

POSTGRES_DB

Database name

POSTGRES_PASSWORD

Database password

POSTGRES_USER

Database user

PROMETHEUS_METRICS=true

Serves a Prometheus server request information exporter at /metrics

QUERY_DEPTH_LIMIT

Default 10 Used to set depthLimit

TRACING=true

Passed as an option to ApolloServer