mirror of
https://github.com/wassname/talk.git
synced 2026-08-17 11:27:52 +08:00
138 lines
5.1 KiB
Markdown
138 lines
5.1 KiB
Markdown
---
|
|
title: Configuring Version 5
|
|
permalink: /v5/configuration/
|
|
toc: true
|
|
---
|
|
|
|
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.
|
|
|
|
## `NODE_ENV`
|
|
|
|
Can be one of `production` or `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`.
|
|
|
|
## `PORT`
|
|
|
|
The port to listen for HTTP and Websocket requests. (Default `3000`)
|
|
|
|
## `DEV_PORT`
|
|
|
|
The port where the Webpack Development server is running on. (Default `8080`)
|
|
|
|
## `MONGODB_URI`
|
|
|
|
The MongoDB database URI to connect to. (Default `mongodb://127.0.0.1:27017/coral`)
|
|
|
|
## `REDIS_URI`
|
|
|
|
The Redis database URI to connect to. (Default `redis://127.0.0.1:6379`)
|
|
|
|
## `REDIS_OPTIONS`
|
|
|
|
A JSON string with optional configuration options to be used when connecting to Redis as specified in the [ioredis](https://github.com/luin/ioredis/blob/1dac50a63753c2afc969315cfe38faf0edc50bc5/API.md#new_Redis_new) documentation. (Default: `{}`)
|
|
|
|
## `SIGNING_SECRET`
|
|
|
|
The shared secret to use to sign JSON Web Tokens (JWT) with the selected signing algorithm. (Default: `keyboard cat`)
|
|
🚨 **Don't forget to set this variable!** 🚨
|
|
|
|
## `SIGNING_ALGORITHM`
|
|
|
|
The signing algorithm to use for signing JWT's. (Default `HS256`).
|
|
|
|
## `LOCALE`
|
|
|
|
Specify the default locale to use for all requests without a locale specified. (Default `en-US`)
|
|
|
|
## `LOGGING_LEVEL`
|
|
|
|
The logging level that can be set to one of `fatal`,
|
|
`error`, `warn`, `info`, `debug`, or `trace`. (Default `info`)
|
|
|
|
## `DISABLE_CLIENT_ROUTES`
|
|
|
|
Disables mounting of client routes for developing with Webpack Dev Server (Default `false`)
|
|
|
|
## `FORCE_SSL`
|
|
|
|
Forces SSL in production by redirecting all HTTP requests to HTTPS, and sending
|
|
HSTS headers. (Default `false`)
|
|
|
|
By default, Coral does not use HTTPS. If you want to enable HTTPS, you must
|
|
configure a proxy in front of Coral such as [Caddy](https://caddyserver.com/).
|
|
|
|
**Troubleshooting**: If you are seeing redirect loops when trying to access
|
|
pages like the admin, you may need to configure [`TRUST_PROXY`](#trust-proxy) to
|
|
tell Coral which upstream proxies to trust.
|
|
|
|
**Warning**: When `FORCE_SSL=true`, Coral will send [HSTS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security)
|
|
headers that will force web browsers to connect via HTTPS for the next 60 days.
|
|
By forcing SSL use you'll need to provide a secure connection to your Coral
|
|
instance for at least the next 60 days.
|
|
|
|
## `DISABLE_LIVE_UPDATES`
|
|
|
|
When `true`, disables subscriptions for the comment stream for all stories across all tenants (Default `false`)
|
|
|
|
## `DISABLE_LIVE_UPDATES_TIMEOUT`
|
|
|
|
Stories that have not received a comment within this time frame will pause live
|
|
live updates automatically. Once a single comment is received on these stories,
|
|
live updates will be re-enabled until the story sits idle for the timeout value.
|
|
|
|
## `DISABLE_RATE_LIMITERS`
|
|
|
|
Disables the rate limiters in development. This will only work when also set to a development environment (Default `false`)
|
|
|
|
## `DISABLE_TENANT_CACHING`
|
|
|
|
When `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 `false`)
|
|
|
|
## `ENABLE_GRAPHIQL`
|
|
|
|
When `true`, it will enable the `/graphiql` even in production, **use with care**. (Default `false`)
|
|
|
|
## `METRICS_USERNAME`
|
|
|
|
The username for _Basic Authentication_ at the `/metrics` endpoint. If not
|
|
provided with `METRICS_PASSWORD`, no authentication will be added to this route.
|
|
|
|
## `METRICS_PASSWORD`
|
|
|
|
The password for _Basic Authentication_ at the `/metrics` endpoint. If not
|
|
provided with `METRICS_USERNAME`, no authentication will be added to this route.
|
|
|
|
## `METRICS_PORT`
|
|
|
|
Metrics are provided at this port under `/metrics`. (Default `9000`)
|
|
|
|
## `SCRAPE_TIMEOUT`
|
|
|
|
The request timeout (in ms) for scraping operations. (Default `10 seconds`)
|
|
|
|
## `SCRAPE_MAX_RESPONSE_SIZE`
|
|
|
|
The maximum size (in bytes) to allow for scraping responses. (Default `10e6`)
|
|
|
|
## `STATIC_URI`
|
|
|
|
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.
|
|
|
|
## `TRUST_PROXY`
|
|
|
|
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 `TRUST_PROXY` setting.
|
|
Refer to https://expressjs.com/en/guide/behind-proxies.html for possible values
|
|
of this configuration variable as it pertains to your setup.
|
|
|
|
## `WEBSOCKET_KEEP_ALIVE_TIMEOUT`
|
|
|
|
A duration in a parsable format (e.g. `30 seconds`, `1 minute`) that should be used to send keep alive messages through the websocket to keep the socket alive. (Default `30 seconds`)
|
|
|
|
## `WORD_LIST_TIMEOUT`
|
|
|
|
The word list timeout (in ms) that should be used to limit the amount of time
|
|
the process is frozen processing a word list comparison. (Default `100`)
|