Configuring Version 5
The following environment variables can be set to configure the Coral Server. You
can expose them in your shell via
export NODE_ENV=development or by placing
the variables in a
.env file in the root of the project in a simple
NODE_ENV=development format delimited by newlines.
Can be one of
development. All production deployments should use
production. Defaults to
production when ran with
npm run start and
development when run with
npm run start:development.
The port to listen for HTTP and Websocket requests. (Default
The port where the Webpack Development server is running on. (Default
The MongoDB database URI to connect to. (Default
The Redis database URI to connect to. (Default
A JSON string with optional configuration options to be used when connecting to Redis as specified in the ioredis documentation. (Default:
The shared secret to use to sign JSON Web Tokens (JWT) with the selected signing algorithm. (Default:
🚨 Don’t forget to set this variable! 🚨
The signing algorithm to use for signing JWT’s. (Default
The number of worker nodes to spawn to handle web traffic, this should be tied to the number of CPU’s available. (Default
Specify the default locale to use for all requests without a locale specified. (Default
The logging level that can be set to one of
Disables mounting of client routes for developing with Webpack Dev Server (Default
Disables forcing SSL in production environments. Should not be used except for testing (Default
true, disables subscriptions for the comment stream for all stories across all tenants (Default
true, Coral will not perform indexing operations when it starts up. This can be desired when you’ve already installed Coral on the target MongoDB, but want to improve start performance.
You should not use this parameter unless you know what you’re doing! Upgrades may introduce additional indexes that the application relies on.
Disables the rate limiters in development. This will only work when also set to a development environment (Default
true, all tenants will be loaded from the database when needed rather than keeping a in-memory copy in sync via published events on Redis. (Default
true, it will enable the
/graphiql even in production, use with care. (Default
The username for Basic Authentication at the
The password for Basic Authentication at the
CONCURRENCY is more than
1, the metrics are provided at this port under
The request timeout (in ms) for scraping operations (Default
The URI that static assets can be accessed from. This URI can be to a proxy that uses this Coral server on
PORT as the upstream. Disabled by default.
When provided, it configures the “trust proxy” settings for Express. If you are encountering issues where urls in the administration are showing with a
http instead of
https, you may need to set the
Refer to https://expressjs.com/en/guide/behind-proxies.html for possible values
of this configuration variable as it pertains to your setup.
A duration in a parsable format (e.g.
1 minute) that should be used to send keep alive messages through the websocket to keep the socket alive (Default