Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 2.81 KB

omen-configuration.md

File metadata and controls

25 lines (18 loc) · 2.81 KB

Configuration

The configuration is, by default, stored in a JSON formatted file called ./config.json.

Users can override the location of the configuration file by setting the environment variable OMEN_CONFIG_FILENAME.

Users can override any configuration value by passing the respective equivalent as environment variables. Option keys can be translated to environment variables by:

  • Prefixing the key with OMEN_, e.g. option key => OMEN_option key.
  • Replacing all spaces with underscores, e.g. OMEN_option key => OMEN_option_key.
  • Converting the whole key to uppercase letters, e.g. OMEN_option_key => OMEN_OPTION_KEY.

Logging in the production container

The gunicorn/production container supports all general options documented here. It additionally allows users to map in a log directory into /home/omenuser/ (configurable via environment variable LOGDIR, which defaults to ~/logs).

Settings

key value description
dbconnection postgresql+psycopg2://username:password@host:port/schema The SQLAlchemy connection string to your database instance.
flask_secret random string The flask secret key used for flask-related ciphers (e.g. protecting session IDs).
log_level debug / info Which Python logging log level to use. Test instances are recommended to use debug, while production environments will likely prefer info.
invite_max_age int, default: 48 Number of hours after which an invite link expires.
feature_user_invite boolean, default: true Determines if users are allowed to invite others.
feature_user_manualcreate boolean, default: true Determines if users are allowed manually create other accounts by specifying full credentials.