expephalon/dbsettings_keys.md

75 lines
2.1 KiB
Markdown

This document includes all database config keys currently used by Expephalon itself. Third-party modules must not use keys in the core.\*, custom.\*, dbsettings.\* or expephalon.\* namespaces, as well as in the namespaces of official modules (chat.\*, demomodule.\*, kumisms.\*, playsms.\*, smsotp.\*, totp.\*), and should use namespaces which are specific enough to prevent collisions with other third-party modules or future official modules. The custom.\* is reserved for settings created manually by administrators for use in custom scripts or other reasons.
[[_TOC_]]
## Base configuration
### core.base_url
**Description**: URL under which this Expephalon installation is available, including protocol, generally without trailing slash, used for generation of absolute URLs
**Default value:** http://localhost:8000
### core.title
**Description**: Title of the Expephalon installation, used in page titles and anywhere else the name of the site is referenced
**Default value:** Expephalon
---
## Authentication system
### core.auth.otp.max_age
**Description:** Maximum time from starting to finishing a one-time-password flow (in seconds)
**Default value:** 300
### core.auth.pwreset.max_age
**Description:** Maximum time between creation and usage of a password reset token (in seconds)
**Default value:** 86400
---
## Mail
### core.mail.sender
**Description:** Email address to be used as sender of outgoing mail
**Default value:** "Expephalon" <expephalon@localhost>
### core.smtp.host
**Description:** Hostname of the SMTP server to be used for outgoing mail
**Default value:** localhost
### core.smtp.username
**Description:** Username to authenticate to the SMTP server with
**Default value:** (None)
### core.smtp.password
**Description:** Password to authenticate to the SMTP server with
**Default value:** (None)
---
## SMS
### core.sms.default
**Description:** Name of the default SMS provider to be used by Expephalon - must be the unique return value of the provider's get_name property
**Default value:** (None, effectively disabling SMS - doesn't make sense without an SMS provider module installed)
---