Skip to content

Documentation

Configuration reference

Every setting for a self-hosted install, where it lives on each path, and how to apply a change.

Where
.env (Docker Compose) · values.yaml (Kubernetes) · /etc/eventier/eventier.env (Linux server)
Permission
Admin of the host, cluster or server
Updated
October 2026

Overview

Docker Compose reads .env, next to compose.yml.

Kubernetes reads your values.yaml: settings go under env.config, and some options are chart values of their own. Secrets go in the Secret that env.existingSecret names, which the bundle's secrets.yaml creates.

A Linux server reads /etc/eventier/eventier.env.

Every setting has a working default except the web address in the Required section of each settings file.

Never replace your settings file with one from a new bundle download: it carries new secrets, and your data is encrypted with the old ones.

Step by step

  1. 01

    Change a setting

    Edit the settings file for your path, then apply the change.

    Apply a changebash
    # Docker Compose: edit .env, then
    docker compose up -d
    
    # Kubernetes: edit values.yaml, then
    helm upgrade eventier oci://ghcr.io/eventierio/charts/eventier --version <x.y.z> -f values.yaml
    
    # Kubernetes: edit secrets.yaml, then
    kubectl apply -f secrets.yaml
    kubectl rollout restart deployment/eventier deployment/eventier-worker
    
    # Linux server: edit /etc/eventier/eventier.env, then
    sudo systemctl restart eventier
  2. 02

    Check the settings

    Problems with a setting are reported when the app starts, and on a server install.sh can check the file before you install.

    • Linux server: run ./install.sh --check in the bundle folder

Every setting

Helm chart values. Docker Compose and the server set the same settings in .env and eventier.env.

KeyKindPurpose
app.urlChart valueThe URL people open. Required. The ingress, or the OpenShift Route, serves its host unless ingress.hosts is set
ingress.enabled · ingress.className · ingress.tlsSecretNameChart valueThe Ingress for app.url, your ingress class and the Secret holding the certificate. Set ingress.enabled: false on OpenShift
openshift.enabledChart valuefalse (default). true serves app.url through a Route and grants the pods their security context constraints
openshift.route.tls.certificate · key · caCertificateChart valuePEM for the Route. Empty uses the router's default certificate
openshift.scc.createChart valuetrue (default) creates the SCC grants, which needs a cluster administrator. false leaves them to an administrator
global.storageClassChart valueThe StorageClass for every volume that names none of its own. Empty uses the cluster default
persistence.size · postgresql.persistence.size · clamav.persistence.sizeChart valueVolume sizes for attachments (10Gi), the bundled PostgreSQL (20Gi in the bundle) and ClamAV's signatures (2Gi)
env.existingSecretChart valueThe Secret holding the secrets below. The bundle's secrets.yaml creates eventier-secrets
EVENTIER_DOMAINCompose .envThe hostname people open. Caddy gets its certificate
NEXT_PUBLIC_APP_URLServer envThe https URL people open
app.editionChart valueself-hosted
postgresql.enabledChart valuetrue (default) runs PostgreSQL 16 in the cluster; false uses your own through DATABASE_URL
EVENTIER_BUNDLED_POSTGRESCompose .env · server envtrue (default) runs PostgreSQL 16 in the stack or has install.sh install it on the server; false uses your own through DATABASE_URL
DATABASE_URLSecretYour own PostgreSQL's connection string. Prefilled for the bundled one on Compose and the server
NEXTAUTH_SECRET · ORG_AUTH_SECRET · AUTH_SECURITY_SECRET · AUTH_MFA_SECRETSecretSession and token signing. Generated in every bundle
SECRET_ENCRYPTION_KEYSecretEncrypts stored integration credentials. Unrecoverable if lost
EVENTIER_SETUP_TOKENSecretFirst-run setup asks for it before it creates the first administrator. Generated in every bundle
env.config.EMAIL_DELIVERY_MODEConfigauto (the bundles' default) sends once SMTP_HOST is set and keeps notifications in-app until then. smtp always sends and needs SMTP_HOST. off sends no email; people sign in with passwords an admin sets or through SSO
env.config.SMTP_HOST · SMTP_PORT · SMTP_FROMConfigOutbound email. SMTP_FROM is required once email is on; SMTP_PORT defaults to 587
SMTP_USER · SMTP_PASSSecretYour relay's login, if it needs one
env.config.SMS_PROVIDERConfigoff (default), sns (Amazon SNS) or webhook (your own gateway). Sends sign-in codes to people who choose text-message MFA
env.config.SMS_WEBHOOK_URL · SMS_WEBHOOK_SECRET (Secret)ConfigThe gateway that receives a signed POST for each text message
AWS_REGION (Config) · AWS_ACCESS_KEY_ID · AWS_SECRET_ACCESS_KEYSecretAmazon SNS for text messages, and Bedrock when it is Evee's provider
env.config.EMAIL_FEEDBACK_SNS_TOPIC_ARNSConfigAmazon SES only: topics allowed to post bounces and complaints
env.config.ATTACHMENT_STORAGE_DRIVERConfiglocal (default) or s3
env.config.ATTACHMENT_S3_ENDPOINT · _BUCKET · _REGION · access keysConfigS3-compatible attachment store
env.config.S3_SERVER_SIDE_ENCRYPTION · S3_CHECKSUM_MODEConfignone · when_required for Cloudflare R2
ATTACHMENT_MALWARE_SCANNERCompose .env · server envclamav (default) or off. Off stores uploads without a scan; on Compose the clamav service then does not start. Files stored while off stay unscanned
clamav.enabled · clamav.persistence.size · storageClassNameChart valueBundled clamd and its signature volume. clamav.enabled: false alone turns scanning off on a self-hosted install
clamav.signatureUpdatesChart valuetrue (default) downloads signature updates. false for an air-gapped cluster: clamd loads the files you copy onto its volume
CLAMAV_NO_FRESHCLAMDCompose .envfalse (default). true stops signature downloads; clamd loads the files you copy onto the clamav-db volume
env.config.CLAMAV_HOST · CLAMAV_PORTConfigAn external clamd
env.config.AI_PROVIDER · AI_DISABLEDConfiganthropic, bedrock or openai_compatible on your own credits. AI_DISABLED=true turns Evee off
env.config.AI_EMBEDDING_PROVIDER · AI_EMBEDDING_MODEL · AI_BASE_URLConfigThe embedding provider for semantic search, Similar past tickets and the weekly digest: openai_compatible (with AI_BASE_URL) or bedrock. Unset follows AI_PROVIDER when it has embeddings; Anthropic has none
retention.auditLogDays · signInLogDays · securityLogDaysChart valueAudit log retention in days, or unlimited. Empty keeps the logs for good
AUDIT_RETENTION_DAYS · AUTH_AUDIT_RETENTION_DAYS · SECURITY_AUDIT_RETENTION_DAYSCompose .env · server envThe same retention for the change log, sign-ins and security events. unlimited (the bundles' default) keeps them for good
env.config.AIRGAPConfigtrue for an install with no internet route. Hides the EvenTier support link
env.config.TRUSTED_PROXY_HOPSConfigProxies in front of the app that append X-Forwarded-For (an ingress alone is 1)
SAML_SP_PRIVATE_KEY · SAML_SP_CERTIFICATESecretOptional PEM pair that signs SAML AuthnRequests
EVENTIER_BIND · PORTServer envListen address, 127.0.0.1:3000 by default

Good to know

  • Retention windows for logs and other records have their own settings. See Data retention.
  • Keep a copy of the settings file with your database backups: the data can't be read without SECRET_ENCRYPTION_KEY.
  • A Secret kind goes in .env or eventier.env on Compose and the server, and in secrets.yaml on Kubernetes.