LogoCTRL

Configuration

Configuring CTRL

In production, configuration is via helm values.yaml config key.

For local use, configuration is via json5 files in the application/backend/config directory.

Either way, the structure of the configuration object is the same.

Config template

For example, adding:

config:
  disableAdminPasswordLogin: true

to values.yaml will disable password based login (OIDC login only)

Config Options

  • smtp: SMTP server ctrl can use to send emails, fields:
    • host:
    • port:
    • username:
    • password:
  • disableAdminPasswordLogin: Disables admin console access via password (OIDC login only)
  • otp: Require participants to enter a one time password sent to their email address to log in
  • oidc: A list of oidc providers, fields:
    • name: Name of provider
    • providerUrl: Base URL for OIDC provider
    • icon: URL of image file to be used for login button
    • clientId: Client ID
    • clientSecret: Client secret
    • displayInAdminPortal: Enable this login method for Admin Portal
    • displayInUserPortal: Enable this login method for User Portal

On this page