Ephios is configured via environment variables. Its often easiest to create a .env file and point ephios to it via the ENV_PATH environment variable.
Most variables have a corresponding django setting. See the django docs for a more in-depth explanation of what they do.
The following variables are available (plugins and some niche features might require additional environment variables).
Path to an environment file. Defaults to .env in the location of the ephios package. We recommend setting most of the following variables in this file.
Defaults to ephios.settings. If you want to use your own settings file, set this to the path to your settings file. This variable cannot be set in the environment file.
Required. Set to True to enable debug mode. Must be False in production.
Set to True to enable the django debug toolbar. Must be False in production. Defaults to False.
Comma-separated list of IP addresses that are allowed to access the debug toolbar. Defaults to 127.0.0.1.
Important. Django secret key used to encrypt session data and other sensitive information. Defaults to a random value persisted into PRIVATE_DIR/.secret.
Path to the private key used to sign web push notifications. If not provided, web push notifications wont work on some platforms. See Config file for details. Defaults to PRIVATE_DIR/vapid_key.pem. A keypair is automatically generated if it does not exist.
Data storage and Logging
Important. Base path where ephios defaults to store files. Defaults to a data folder in the location of the ephios package, which is not recommended for production use.
Path where public files are stored. Defaults to DATA_DIR/public.
Path where static files (css/js) are collected to. A reverse proxy should be configured to serve them at STATIC_URL. Defaults to PUBLIC_DIR/static.
Path where private files are stored. Defaults to DATA_DIR/private. Make sure access to this folder is restricted to the user running ephios.
Path where uploaded files are stored. Defaults to PRIVATE_DIR/media. You should backup this folder regularly.
Path to the folder where log files are put. Files inside are rotated daily. Defaults to PRIVATE_DIR/logs.
Number of days to keep log files. Defaults to 14.
Database and Caching
Required. URL to the database. See django-environ for details.
Number of seconds to keep database connections open. Defaults to 0, meaning connections are closed after each request. Refer to the django docs for details.
URL to the cache. We recommend redis. See django-environ for details.
URLs and Routing
Required. Comma-separated list of hostnames that are allowed to access the ephios instance.
Required. URL used to construct absolute URLs in emails and other places.
URL where the static files can be found by browsers. Defaults to
/static/, meaning they are served by the same host.
Number of seconds to set the Strict-Transport-Security header to. Defaults to the amount of seconds in 1 day, but should be set to a higher value in production.
Include subdomains in the Strict-Transport-Security header. Defaults to False.
ephios must be served over HTTPS in production. In some setups, ephios is behind a reverse proxy that terminates SSL connections and the Origin header is not set with a https scheme. In this case, the proxy can communicate the fact that the connection is secure by setting the X-Forwarded-Proto header. Then this setting must be set to True. See django docs for details. Defaults to False.
Required. URL to the email smtp server. See django-environ for details.
Required. Email address that is used as the sender for all emails sent by ephios. (Django docs)
Required. Email address that is used as the sender for all error emails sent by django. (Django docs)
Required. Email addresses that receive error emails.