config.yaml

# Copyright 2024 Canonical Ltd.
# See LICENSE file for licensing details.
options:
  cors_origin:
    type: string
    description: "Cors origin string to use, defaults to '*'."
    default: "*"
  developer_emails:
    type: string
    description: "Comma delimited list of email addresses that should have developer level access."
    default: ""
  enable_cors:
    type: boolean
    description: "Enable Cross-origin Resource Sharing (CORS) at the application level (required for SSO)."
    default: true
  external_hostname:
    type: string
    description: "External hostname this discourse instance responds to. Defaults to application name."
    default: ""
  force_https:
    type: boolean
    description: Configure Discourse to use https.
    default: false
  force_saml_login:
    type: boolean
    description: "Force SAML login (full screen, no local database logins)."
    default: false
  saml_sync_groups:
    type: string
    description: "Comma-separated list of groups to sync from SAML provider."
    default: ""
  smtp_address:
    type: string
    description: "Hostname / IP that should be used to send SMTP mail."
    default: ""
  smtp_authentication:
    type: string
    description: "Type of smtp authentication to use. Valid values: none, login, plain, cram_md5."
    default: "none"
  smtp_domain:
    type: string
    description: "Hostname that email sent by this discourse should appear to come from."
    default: ""
  smtp_enable_start_tls:
    type: string
    description: "Enable TLS encryption for smtp connections."
    default: "true"
  smtp_force_tls:
    type: string
    description: "Force implicit TLS as per RFC 8314 3.3."
    default: "false"
  smtp_openssl_verify_mode:
    type: string
    description: "Should discourse verify SSL certs."
    default: "none"
  smtp_password:
    type: string
    description: "Password to use when sending mail via SMTP."
    default: ""
  smtp_port:
    type: int
    description: "Port to use when connecting to SMTP server."
    default: 587
  smtp_username:
    type: string
    description: "Username to use when sending mail via SMTP."
    default: ""
  s3_access_key_id:
    type: string
    description: |
      The S3 access key ID to use.

      Sets DISCOURSE_S3_ACCESS_KEY_ID.
      Required if s3_enabled is true.
    default: ""
  s3_backup_bucket:
    type: string
    description: |
      The S3 bucket to use for backups.

      Sets DISCOURSE_S3_BACKUP_BUCKET.
      Also sets DISCOURSE_BACKUP_LOCATION=s3.
    default: ""
  s3_bucket:
    type: string
    description: |
      The S3 bucket to use.

      Sets DISCOURSE_S3_BUCKET.
      Required if s3_enabled is true.
    default: ""
  s3_cdn_url:
    type: string
    description: |
      The S3 Content Delivery Network URL.

      Sets DISCOURSE_S3_CDN_URL.
    default: ""
  s3_enabled:
    type: boolean
    description: |
      Store uploaded objects in an S3-compatible object storage service instead of a local directory.

      If true, sets DISCOURSE_USE_S3=true.
      Check https://meta.discourse.org/t/using-object-storage-for-uploads-s3-clones/148916 for more details.
    default: false
  s3_endpoint:
    type: string
    description: |
      The S3 endpoint to use.  This may be a non-Amazon S3-compatible endpoint.

      Sets DISCOURSE_S3_ENDPOINT
    default: "https://s3.amazonaws.com"
  s3_region:
    type: string
    description: |
      The S3 region to use.

      Sets DISCOURSE_S3_REGION.
      Required if s3_enabled is true.
    default: ""
  s3_secret_access_key:
    type: string
    description: |
      The S3 secret key to use.

      Sets DISCOURSE_S3_SECRET_ACCESS_KEY.
      Required if s3_enabled is true.
    default: ""
  s3_install_cors_rule:
    type: boolean
    description: |
      Will discourse set cors rule on the S3 bucket.

      Sets DISCOURSE_S3_INSTALL_CORS_RULE
    default: true
  throttle_level:
    type: string
    description: "Throttle level - blocks excessive usage by ip. Accepted values: none, permissive, strict."
    default: none