Skip to content

Configuration ​

quantum.config.yaml, next to the app. ${NAME} in any value is the environment variable NAME (CFG-1); a section not listed here is warned about.

api ​

KeyTypeDefaultRules
openapiboolCFG-3
titleAPI-7 · CFG-3 · UI-1 · UI-4 · UI-10
versionAPI-7 · CFG-3

Another key in this section is warned about when the configuration is loaded (CFG-2, CFG-3).

Specified by: API-7 · CFG-3

components ​

Accepted; its keys are not checked.

Specified by: EXEC-1 · CFG-3

database ​

Accepted; its keys are not checked.

Specified by: DB-7 · DB-8 · SET-2 · TEST-2

datasources ​

A map of datasource name → its keys (DB-7): datasources: {db: {driver: sqlite, database: ./app.db}}.

KeyTypeDefaultRules
database
driver
history
host
password
port
type
user
username

Specified by: DB-7

defaults ​

Accepted; its keys are not checked.

deploy ​

Accepted; its keys are not checked.

development ​

Accepted; its keys are not checked.

jobs ​

Accepted; its keys are not checked.

llm ​

KeyTypeDefaultRules
base_urlstrIA-1
default_modelIA-1
modelIA-1
timeoutint

Accepted; its keys are not checked.

Specified by: IA-1 · IA-5 · IA-7

logging ​

KeyTypeDefaultRules
consoleTrueCFG-3
fileTrueCFG-3 · IA-8 · PARSE-5 · UI-9
filenamequantum.logCFG-3 · FILE-1
formatCFG-3 · SET-3
levelINFOCFG-3

Another key in this section is warned about when the configuration is loaded (CFG-2, CFG-3).

Specified by: CFG-3

mail ​

KeyTypeDefaultRules
fromCOMP-1 · LOOP-5 · MAIL-1
hostCFG-3 · MAIL-1
passwordMAIL-1
portCFG-3 · MAIL-1
timeoutDB-5 · FN-2 · INV-1 · MAIL-1
tlsMAIL-1
usernameMAIL-1

Another key in this section is warned about when the configuration is loaded (CFG-2, CFG-3).

Specified by: MAIL-1 · MAIL-2 · CFG-3

messaging ​

Accepted; its keys are not checked.

paths ​

KeyTypeDefaultRules
components./componentsCFG-3 · COMP-1 · DEV-4
logs./logsCFG-3
migrationsCFG-3 · TEST-1
static./staticCFG-3 · DEV-4
uploadsCFG-3 · FILE-1 · FILE-2

Another key in this section is warned about when the configuration is loaded (CFG-2, CFG-3).

Specified by: COMP-1 · FILE-1 · FILE-2 · CFG-3 · DEV-4 · TEST-1

performance ​

KeyTypeDefaultRules
cache_max_size100
cache_templatesTrue
cache_ttl300

Another key in this section is warned about when the configuration is loaded (CFG-2, CFG-3).

Specified by: CFG-2

security ​

KeyTypeDefaultRules
login_urlAUTH-4
max_content_lengthint16777216API-5 · CFG-2
python_scriptingbool
secret_keyDEV-2
xss_protectionTrue

Another key in this section is warned about when the configuration is loaded (CFG-2, CFG-3).

Specified by: API-5 · AUTH-4 · CFG-2

server ​

KeyTypeDefaultRules
debugboolFalseAPI-6 · CFG-3
hoststr127.0.0.1CFG-3 · MAIL-1
portint8080CFG-3 · MAIL-1
proxiesintAPI-5 · CFG-3
reloadboolTrueCFG-3 · UI-15

Another key in this section is warned about when the configuration is loaded (CFG-2, CFG-3).

Specified by: API-5 · API-6 · IA-1 · CFG-3 · CFG-4 · UI-22 · DEV-1

services ​

Accepted; its keys are not checked.

Specified by: SVC-2

ui ​

KeyTypeDefaultRules
motion

Another key in this section is warned about when the configuration is loaded (CFG-2, CFG-3).

Specified by: LOOP-6 · EXEC-1 · DB-11 · EXPR-11 · IA-7 · APP-1 · UI-1 · UI-2 · UI-3 · UI-4 · UI-5 · UI-6 · UI-7 · UI-9 · UI-10 · UI-11 · UI-12 · UI-13 · UI-14 · UI-16 · UI-17 · UI-19 · UI-20 · UI-21 · DEV-3

MIT Licensed · Built with VitePress