mode (optional)

field mode
env var MODE
default dev

base_url (optional)

field base_url
env var BASE_URL, SITE_URL
default http://localhost:8000

secret_key

field secret_key
env var SECRET_KEY

Admin Emails (optional)

Email Address of Instance Admins

field admin_emails
env var ADMIN_EMAILS
examples admin1@example.com,admin2@example.com

Instance admins can access the admin interface, e.g. to configure App Settings

Frontend directory (optional)

Directory to serve frontend files from, if you are not using something else to serve them

field frontend_dir
env var FRONTEND_DIR

Allowed hosts (optional)

field allowed_hosts
env var ALLOWED_HOSTS
default *

CSRF Trusted Origins (optional)

field csrf_trusted_origins
env var CSRF_TRUSTED_ORIGINS
default http://127.0.0.1:8000

GeoIP Path (optional)

field geoip_path
env var GEOIP_PATH

Listen options

File descriptor (optional)

field listen.fd
env var LISTEN_FD

Host (optional)

field listen.host
env var LISTEN_HOST

Port (optional)

field listen.port
env var LISTEN_PORT

Unix socket (optional)

field listen.socket
env var LISTEN_SOCKET

Concurrency (optional)

How many web workers

field listen.concurrency
env var LISTEN_CONCURRENCY, WORKER_COUNT
default 1

request timeout seconds (optional)

field listen.request_timeout_seconds
env var REQUEST_TIMEOUT_SECONDS
default 60

Database options

Database name

field database.name
env var DATABASE_NAME

User

field database.user
env var DATABASE_USER

Password

field database.password
env var DATABASE_PASSWORD

Host (optional)

field database.host
env var DATABASE_HOST
default localhost

Port (optional)

field database.port
env var DATABASE_PORT
default 5432

Connection max age (optional)

field database.connection_max_age
env var DATABASE_CONN_MAX_AGE
default 0

database statement query timeout during requests (optional)

field database.request_timeout_seconds
env var REQUEST_DATABASE_TIMEOUT_SECONDS
default 60

Redis options

Host (optional)

field redis.host
env var REDIS_HOST
default localhost

Port (optional)

field redis.port
env var REDIS_PORT
default 6379

Unix socket (optional)

field redis.socket
env var REDIS_SOCKET

Database (optional)

field redis.db
env var REDIS_DB
default 0

Worker options

immediate (optional)

field worker.immediate
default False

count (optional)

field worker.count
default 1

Upload options

dir (optional)

field uploads.dir
env var FILE_UPLOAD_DIR
default ./uploads/

temp_dir (optional)

field uploads.temp_dir
env var FILE_UPLOAD_TEMP_DIR

permissions (optional)

field uploads.permissions
env var FILE_UPLOAD_PERMISSIONS

directory_permissions (optional)

field uploads.directory_permissions
env var FILE_UPLOAD_DIRECTORY_PERMISSIONS

Plugin options

dir (optional)

field plugins.dir
env var PLUGIN_DIR
default ./plugins/

Sentry options

dsn (optional)

field sentry.dsn
env var SENTRY_DSN

environment (optional)

field sentry.environment
env var SENTRY_ENVIRONMENT
default production

client_dsn (optional)

field sentry.client_dsn
env var SENTRY_CLIENT_DSN

release (optional)

field sentry.release
env var SENTRY_RELEASE

release_use_git_rev (optional)

field sentry.release_use_git_rev
env var SENTRY_RELEASE_USE_GIT_REV
default True

Influxdb options

host

field influx_db.host
env var INFLUXDB_HOST

port

field influx_db.port
env var INFLUXDB_PORT

user

field influx_db.user
env var INFLUXDB_USER

password

field influx_db.password
env var INFLUXDB_PASSWORD

database name

field influx_db.database
env var INFLUXDB_NAME

timeout (optional)

field influx_db.timeout
env var INFLUXDB_TIMEOUT
default 5