🎚 Configuration

Noddl allows the configuration over enviornment variables:

All settings of Notes.

Note

• Settings marked with 🔴 are explicitly required.

• Settings marked with ⭕ are implicitly required, but have an overridable default.

confirm.noddl.settings.ALLOWED_ORIGINS = '*'

⭕ Comma-separated list of allowed origins for WebSocket connections. Set to * to allow all origins.

confirm.noddl.settings.APP_SECRET = '01ee2408dcbf56667e8e1de13368ae6817b856db3e08ce69d0ad612afaa6e902'

⭕ The application secret.

Hint

If not set explicitly, a random 32-char token will be generated.

confirm.noddl.settings.BOARD_GC_DAYS = 365

⭕ Number of days after which inactive boards are garbage-collected. Set to 0 to disable automatic cleanup.

confirm.noddl.settings.DATABASE_URL = 'sqlite:////data/noddl.db'

⭕ The database URL.

confirm.noddl.settings.DATA_DIR = PosixPath('/data')

⭕ The base directory for persistent data (database, etc.).

confirm.noddl.settings.JWT_ALGORITHM = 'HS256'

⭕ The JWT algorithm.

Warning

Usually this algorithm shouldn’t be changed.

confirm.noddl.settings.JWT_EXPIRATION = 300

⭕ The expiration of the short-lived JWT token in seconds.

confirm.noddl.settings.JWT_SECRET = '01ee2408dcbf56667e8e1de13368ae6817b856db3e08ce69d0ad612afaa6e902'

⭕ The JWT secret.

Hint

If not set explicitly, the APP_SECRET is used instead.

confirm.noddl.settings.LOG_LEVEL = 'INFO'

⭕ The log level (must match one of the Python logging levels).

confirm.noddl.settings.OIDC_ADMIN_GROUP = 'admins'

The OIDC group that grants admin access.

confirm.noddl.settings.OIDC_CLIENT_ID = 'noddl'

The OIDC client ID.

confirm.noddl.settings.OIDC_CLIENT_SECRET = None

The OIDC client secret.

confirm.noddl.settings.OIDC_DISCOVERY_URL = None

The OIDC discovery URL (e.g. https://sso.example.com/.well-known/openid-configuration).

confirm.noddl.settings.sanity_checks()

Run sanity checks of the settings module.