mirror of
https://github.com/wassname/talk.git
synced 2026-07-12 16:04:41 +08:00
Wyatt Johnson
94 lines
4.2 KiB
Markdown
94 lines
4.2 KiB
Markdown
---
|
|
title: Configuration
|
|
permalink: /docs/running/configuration/
|
|
---
|
|
|
|
## Overview
|
|
|
|
Talk, like many web applications, requires manual configuration via environment
|
|
variables to configure the server for your specific needs. This is following the
|
|
standard [12 Factor App Manifesto](https://12factor.net/) which requires that
|
|
said configuration lives as environment variables.
|
|
|
|
During development, we can utilize a `.env` file, which takes the form of
|
|
`NAME=VALUE`. For example:
|
|
|
|
```bash
|
|
TALK_MONGO_URL=mongodb://some-awesome-mongo-instance
|
|
TALK_REDIS_URL=redis://some-awesome-redis-instance
|
|
TALK_ROOT_URL=https://my-awesome-talk.com
|
|
# ... and so on
|
|
```
|
|
|
|
When you place a file titled `.env` at the root of the project, and start the
|
|
application with `yarn dev-start`, it will read in the contents of the `.env`
|
|
file as if they were environment variables. This is done via the
|
|
[dotenv](https://github.com/motdotla/dotenv) package. In production, using this
|
|
method is discouraged, as it promotes bad practices such as storing config in a
|
|
file.
|
|
|
|
## Variables
|
|
|
|
The Talk application looks for the following configuration values either as
|
|
environment variables. Refer to the
|
|
[config.js](https://github.com/coralproject/talk/blob/master/config.js) file to
|
|
see how the configuration is parsed.
|
|
|
|
### Database
|
|
|
|
- `TALK_MONGO_URL` (*required*) - the database connection string for the MongoDB database.
|
|
- `TALK_REDIS_URL` (*required*) - the database connection string for the Redis database.
|
|
|
|
### Server
|
|
|
|
- `TALK_ROOT_URL` (*required*) - root url of the installed application externally
|
|
available in the format: `<scheme>://<host>` without the path.
|
|
- `TALK_KEEP_ALIVE` (_optional_) - The keepalive timeout that should be used to
|
|
send keep alive messages through the websocket to keep the socket alive. (Default `30s`)
|
|
- `TALK_INSTALL_LOCK` (_optional for dynamic setup_) - When `TRUE`, disables the dynamic setup endpoint. (Default `FALSE`)
|
|
|
|
### JWT
|
|
|
|
If a non-HMAC based signing method is used (such as `RS256` or `ES256`) as your
|
|
choice for `TALK_JWT_ALG`, you must use a PEM encoded certificate.
|
|
If you are using the core auth method, then a private key must be provided as we
|
|
then perform key signing.
|
|
If you are using an external mechanism to handle key signing by passing the auth
|
|
details through the PYM bridge (documentation on the way!) then you can instead
|
|
provide a public key.
|
|
|
|
- `TALK_JWT_ALG` (_optional_) - the algorithm used to sign/verify JWT's used for
|
|
session management. Read up about alternative algorithms on the
|
|
[jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken#algorithms-supported) package. (Default `HS256`)
|
|
- `TALK_JWT_SECRET` (*required*) - The shared secret or certificate (depending
|
|
on your choice of `TALK_JWT_ALG`) used for jwt tokens.
|
|
- `TALK_JWT_EXPIRY` (_optional_) - the expiry duration (`exp`) for the tokens
|
|
issued for logged in sessions. (Default `1 day`)
|
|
- `TALK_JWT_ISSUER` (_optional_) - the issuer (`iss`) claim for login JWT
|
|
tokens. (Default `process.env.TALK_ROOT_URL`)
|
|
- `TALK_JWT_AUDIENCE` (_optional_) - the audience (`aud`) claim for login JWT
|
|
tokens. (Default `talk`)
|
|
|
|
### Email
|
|
|
|
- `TALK_SMTP_EMAIL` (*required for email*) - the address to send emails from
|
|
using the SMTP provider.
|
|
- `TALK_SMTP_USERNAME` (*required for email*) - username of the SMTP provider
|
|
you are using.
|
|
- `TALK_SMTP_PASSWORD` (*required for email*) - password for the SMTP provider
|
|
you are using.
|
|
- `TALK_SMTP_HOST` (*required for email*) - SMTP host url with format
|
|
`smtp.domain.com`, note the lack of protocol on the domain.
|
|
- `TALK_SMTP_PORT` (*required for email*) - SMTP port.
|
|
|
|
|
|
### Recaptcha
|
|
|
|
- `TALK_RECAPTCHA_SECRET` (*required for reCAPTCHA support*) - server secret used for enabling reCAPTCHA powered logins. If not provided it will instead default to providing only a time based lockout.
|
|
- `TALK_RECAPTCHA_PUBLIC` (*required for reCAPTCHA support*) - client secret used for enabling reCAPTCHA powered logins. If not provided it will instead default to providing only a time based lockout.
|
|
|
|
### Plugins
|
|
|
|
- `TALK_PLUGINS_JSON` (_optional_) - used to specify the plugin config via the
|
|
environment.
|
|
- `TALK_DISABLE_AUTOFLAG_SUSPECT_WORDS` (_optional_) When `TRUE`, disables flagging of comments that match the suspect word filter. (Default `FALSE`) |