Documentation for configuration options. The majority of essential configuration options are available through environment variables. The rest of the configuration options are available in configs
directory.
Configuration options for the application are available in configs/app.config.ts.
Environment variable: PORT
Default: 8000
The environment the application is running in.
Environment variable: NODE_ENV
Default: development
Valid values: development
, production
The name of the application.
Environment variable: APP_NAME
Default: app
The email address and password of the admin user. This user will be created if it does not exist. If at least one of the variables is not set, the admin user will not be created.
Environment variable: ADMIN_EMAIL
Environment variable: ADMIN_PASSWORD
The key used to sign JWT tokens.
Environment variable: JWT_KEY
Require email verification for new users. If set to true
, users will not be able to log in until they verify their email address.
Environment variable: REQUIRE_VERIFICATION
Default: false
Valid values: true
, false
Configuration for postgres database connection. Other configuration options are available in configs/database.config.ts
.
Environment variable: DB_HOST
Environment variable: DB_PORT
Environment variable: DB_USER
Environment variable: DB_PASSWORD
Environment variable: DB_NAME
Configuration for email sending. Other configuration options are available in configs/email.config.ts.
Environment variable: EMAIL_HOST
Environment variable: EMAIL_PORT
Environment variable: EMAIL_USER
Environment variable: EMAIL_PASSWORD
Environment variable: EMAIL_FROM
Configuration options for logging are available in configs/logger.config.ts.
Configuration options for security are available in configs/security.config.ts.
Configuration options for translations are available in configs/translations.config.ts.