Skip to main content

Configuration

Below is a list of configuration options that can be found in your .env file:

tip

You'll need to restart the backend container after modifying your .env file

Environment variableRequiredDescription
JWT_SECRETYesYour unique secret that signs all authenticated requests. Treat this as securely as you would a database password
API_SECRETYes32-character secret for encrypting API keys
DASHBOARD_URLYesThe URL of your frontend. Used for setting CORS headers and in emails
DB_HOSTYesThe host name for your database. If using containers, this is typically the name of your database service
DB_PORTYesThe port your database runs on, usually 3306
DB_NAMEYesThe name of your database
DB_USERYesThe user which has access to your database
DB_PASSYesThe password for the database user
EMAIL_DRIVERNoThis can be set to 'log' (default, prints to the console) or 'relay' (send via an external SMTP server)
EMAIL_HOSTNoThe host for the 'relay' server, e.g. smtp.mailserver.com
EMAIL_PORTNoThe port for the 'relay' server, usually 587 or 465
EMAIL_USERNAMENoThe username for the 'relay' server, e.g. [email protected]
EMAIL_PASSWORDNoThe password for the 'relay' server
EMAIL_DEBUGNoSet this environment variable to print debug info about emails to the console
FROM_EMAILNoThe email address used to send emails from the backend
AUTO_CONFIRM_EMAILNoA boolean that defines whether users have their emails automatically confirmed after signing up
CLICKHOUSE_HOSTYesThe host name for your ClickHouse instance. If using containers, this is typically the name of your ClickHouse service
CLICKHOUSE_PORTNoThe port your ClickHouse instance runs on, usually 8123
CLICKHOUSE_DBYesThe name of your ClickHouse database
CLICKHOUSE_USERYesThe user which has access to your ClickHouse database
CLICKHOUSE_PASSWORDYesThe password for the ClickHouse database user
REDIS_PASSWORDYesThe password for your Redis instance
RECOVERY_CODES_SECRETNo32-character secret for encrypting your 2FA recovery codes, required to use 2FA
STEAM_INTEGRATION_SECRETNo32-character secret for encrypting your Steam API key, required to use the Steamworks integration
REGISTRATION_MODENoControls how registrations work: 'open' (default, open to anyone), 'exclusive' (invite-only) or 'disabled'

Third party configurations

Talo uses a handful of third party services to handle common tasks.

Emails

Talo can relay emails via an external SMTP server (like Gmail or Zoho) using the "relay" EMAIL_DRIVER. Under the hood, Talo uses Nodemailer to handle the relay and you can refer to their docs for example configurations.

Sentry

Sentry is an error monitoring tool with a generous free tier. You can enable Sentry by setting the SENTRY_DSN environment variable to your unique DSN.