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 whitelist.

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.

ENGINE_API_KEY: String

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

HASURA_URI

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

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

WHITELIST_PATH: String

Path to a whitelist generated by persistgraphql. Not compatible with ALLOW_INTROSPECTION