Skip to main content

Configuration

This page details all the authentik configuration options that you can set via environment variables.

About authentik configurations​

info

The double-underscores are intentional, as all these settings are translated to YAML internally, and a double-underscore indicates the next level (a subsetting).

All of these variables can be set to values, but you can also use a URI-like format to load values from other places:

  • env://<name> Loads the value from the environment variable <name>. Fallback can be optionally set like env://<name>?<default>
  • file://<name> Loads the value from the file <name>. Fallback can be optionally set like file://<name>?<default>

Set your environment variables​

If you are using Docker Compose, edit your .env file to append any keys that you want to add, and then run the following command to apply them:

docker compose up -d

Verify your configuration settings​

To check if your config has been applied correctly, you can run the following command to output the full config:

docker compose run --rm worker dump_config

PostgreSQL Settings​

  • AUTHENTIK_POSTGRESQL__HOST: Hostname of your PostgreSQL Server
  • AUTHENTIK_POSTGRESQL__NAME: Database name
  • AUTHENTIK_POSTGRESQL__USER: Database user
  • AUTHENTIK_POSTGRESQL__PORT: Database port, defaults to 5432
  • AUTHENTIK_POSTGRESQL__PASSWORD: Database password, defaults to the environment variable POSTGRES_PASSWORD
  • AUTHENTIK_POSTGRESQL__USE_PGBOUNCER: Adjust configuration to support connection to PgBouncer. Deprecated, see below
  • AUTHENTIK_POSTGRESQL__USE_PGPOOL: Adjust configuration to support connection to Pgpool. Deprecated, see below
  • AUTHENTIK_POSTGRESQL__SSLMODE: Strictness of ssl verification. Defaults to "verify-ca"
  • AUTHENTIK_POSTGRESQL__SSLROOTCERT: CA root for server ssl verification
  • AUTHENTIK_POSTGRESQL__SSLCERT: Path to x509 client certificate to authenticate to server
  • AUTHENTIK_POSTGRESQL__SSLKEY: Path to private key of SSLCERT certificate
  • AUTHENTIK_POSTGRESQL__CONN_MAX_AGE: Database connection lifetime. Defaults to 0 (no persistent connections). Can be set to null for unlimited persistent connections. See Django's documentation for more details.
  • AUTHENTIK_POSTGRESQL__CONN_HEALTH_CHECK: Existing persistent database connections will be health checked before they are reused if set to true. Defaults to false. See Django's documentation for more details.
  • AUTHENTIK_POSTGRESQL__DISABLE_SERVER_SIDE_CURSORS: Disable server side cursors when set to true. Defaults to false. See Django's documentation for more details.

The PostgreSQL settings HOST, PORT, USER, and PASSWORD support hot-reloading. Adding and removing read replicas doesn't support hot-reloading.

Read replicas​

You can configure additional read replica databases that are used only for read operations. To configure authentik to use replicas, add the settings below to your configuration file. If you have multiple replicas, add additional settings for each replica, replacing the default 0 with a unique value for each additional replica.

If read replicas are configured, the main database is not used for reads. If you'd like the main database to be included for reads, add it as a read replica.

The same PostgreSQL settings as described above are used for each read replica.

  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__HOST
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__NAME
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__USER
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__PORT
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__PASSWORD
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLMODE
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLROOTCERT
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLCERT
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLKEY
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__CONN_MAX_AGE
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__CONN_HEALTH_CHECK
  • AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__DISABLE_SERVER_SIDE_CURSORS

Using a PostgreSQL connection pooler (PgBouncer or PgPool)​

When your PostgreSQL database(s) are running behind a connection pooler, like PgBouncer or PgPool, two settings need to be overridden:

  • AUTHENTIK_POSTGRESQL__CONN_MAX_AGE

    A connection pooler running in session pool mode (PgBouncer default) can be incompatible with unlimited persistent connections enabled by setting this to null: If the connection from the connection pooler to the database server is dropped, the connection pooler will wait for the client to disconnect before releasing the connection; however this will never happen as authentik is configured to keep the connection to the connection pooler forever.

    To address this incompatibility, either configure the connection pooler to run in transaction pool mode, or update this setting to a value lower than any timeouts that may cause the connection to the database to be dropped (up to 0).

  • AUTHENTIK_POSTGRESQL__DISABLE_SERVER_SIDE_CURSORS

    Using a connection pooler in transaction pool mode (e.g. PgPool, or PgBouncer in transaction or statement pool mode) requires disabling server-side cursors, so this setting must be set to false.

Additionally, you can set AUTHENTIK_POSTGRESQL__CONN_HEALTH_CHECK to perform health checks on persistent database connections before they are re-used.

Redis Settings​

  • AUTHENTIK_REDIS__HOST: Redis server host when not using configuration URL
  • AUTHENTIK_REDIS__PORT: Redis server port when not using configuration URL
  • AUTHENTIK_REDIS__DB: Redis server database when not using configuration URL
  • AUTHENTIK_REDIS__USERNAME: Redis server username when not using configuration URL
  • AUTHENTIK_REDIS__PASSWORD: Redis server password when not using configuration URL
  • AUTHENTIK_REDIS__TLS: Redis server connection using TLS when not using configuration URL
  • AUTHENTIK_REDIS__TLS_REQS: Redis server TLS connection requirements when not using configuration URL. Defaults to "none". Allowed values are "none" and "required".
  • AUTHENTIK_REDIS__TLS_CA_CERT: Path to the Redis server TLS CA root when not using configuration URL. Defaults to null.

Result Backend Settings​

  • AUTHENTIK_RESULT_BACKEND__URL: Result backend configuration URL, uses the Redis Settings by default

Cache Settings​

  • AUTHENTIK_CACHE__URL: Cache configuration URL, uses the Redis Settings by default

  • AUTHENTIK_CACHE__TIMEOUT: Timeout for cached data until it expires in seconds, defaults to 300

  • AUTHENTIK_CACHE__TIMEOUT_FLOWS: Timeout for cached flow plans until they expire in seconds, defaults to 300

  • AUTHENTIK_CACHE__TIMEOUT_POLICIES: Timeout for cached policies until they expire in seconds, defaults to 300

  • AUTHENTIK_CACHE__TIMEOUT_REPUTATION: Timeout for cached reputation until they expire in seconds, defaults to 300

    info

    AUTHENTIK_CACHE__TIMEOUT_REPUTATION only applies to the cache expiry, see AUTHENTIK_REPUTATION__EXPIRY to control how long reputation is persisted for.

Channel Layer Settings (inter-instance communication)​

  • AUTHENTIK_CHANNEL__URL: Channel layers configuration URL, uses the Redis Settings by default

Broker Settings​

  • AUTHENTIK_BROKER__URL: Broker configuration URL, defaults to Redis using the respective settings

  • AUTHENTIK_BROKER__TRANSPORT_OPTIONS: Base64-encoded broker transport options

    info

    AUTHENTIK_REDIS__CACHE_TIMEOUT_REPUTATION only applies to the cache expiry, see AUTHENTIK_REPUTATION__EXPIRY to control how long reputation is persisted for.

Listen Settings​

  • AUTHENTIK_LISTEN__HTTP: Listening address:port (e.g. 0.0.0.0:9000) for HTTP (Applies to Server and Proxy outpost)

  • AUTHENTIK_LISTEN__HTTPS: Listening address:port (e.g. 0.0.0.0:9443) for HTTPS (Applies to Server and Proxy outpost)

  • AUTHENTIK_LISTEN__LDAP: Listening address:port (e.g. 0.0.0.0:3389) for LDAP (Applies to LDAP outpost)

  • AUTHENTIK_LISTEN__LDAPS: Listening address:port (e.g. 0.0.0.0:6636) for LDAPS (Applies to LDAP outpost)

  • AUTHENTIK_LISTEN__METRICS: Listening address:port (e.g. 0.0.0.0:9300) for Prometheus metrics (Applies to All)

  • AUTHENTIK_LISTEN__DEBUG: Listening address:port (e.g. 0.0.0.0:9900) for Go Debugging metrics (Applies to All)

  • AUTHENTIK_LISTEN__TRUSTED_PROXY_CIDRS: List of comma-separated CIDRs that proxy headers should be accepted from (Applies to Server)

    Defaults to 127.0.0.0/8, 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fe80::/10, ::1/128.

    Requests directly coming from one an address within a CIDR specified here are able to set proxy headers, such as X-Forwarded-For. Requests coming from other addresses will not be able to set these headers.

Media Storage Settings​

These settings affect where media files are stored. Those files include applications and sources icons. By default, they are stored on disk in the /media directory of the authentik container. S3 storage is also supported.

  • AUTHENTIK_STORAGE__MEDIA__BACKEND: Where to store files. Valid values are file and s3. For file storage, files are stored in a /media directory in the container. For s3, see below.
  • AUTHENTIK_STORAGE__MEDIA__S3__REGION: S3 region where the bucket has been created. May be omitted depending on which S3 provider you use. No default.
  • AUTHENTIK_STORAGE__MEDIA__S3__USE_SSL: Whether to use HTTPS when talking to the S3 storage providers. Defaults to true.
  • AUTHENTIK_STORAGE__MEDIA__S3__ENDPOINT: Endpoint to use to talk to the S3 storage provider. Override the previous region and use_ssl settings. Must be a valid URL in the form of https://s3.provider. No default.
  • AUTHENTIK_STORAGE__MEDIA__S3__SESSION_PROFILE: Profile to use when using AWS SDK authentication. No default. Supports hot-reloading.
  • AUTHENTIK_STORAGE__MEDIA__S3__ACCESS_KEY: Access key to authenticate to S3. May be omitted if using AWS SDK authentication. Supports hot-reloading.
  • AUTHENTIK_STORAGE__MEDIA__S3__SECRET_KEY: Secret key to authenticate to S3. May be omitted if using AWS SDK authentication. Supports hot-reloading.
  • AUTHENTIK_STORAGE__MEDIA__S3__SECURITY_TOKEN: Security token to authenticate to S3. May be omitted. Supports hot-reloading.
  • AUTHENTIK_STORAGE__MEDIA__S3__BUCKET_NAME: Name of the bucket to use to store files.
  • AUTHENTIK_STORAGE__MEDIA__S3__CUSTOM_DOMAIN: Domain to use to create URLs for users. Mainly useful for non-AWS providers. May include a port. Must include the bucket. Example: s3.company:8080/authentik-media.
  • AUTHENTIK_STORAGE__MEDIA__S3__SECURE_URLS: Whether URLs created use HTTPS (set to true by default) or HTTP.

authentik Settings​

AUTHENTIK_SECRET_KEY​

Secret key used for cookie signing. Changing this will invalidate active sessions.

caution

Prior to 2023.6.0 the secret key was also used for unique user IDs. When running a pre-2023.6.0 version of authentik the key should not be changed after the first install.

AUTHENTIK_LOG_LEVEL​

Log level for the server and worker containers. Possible values: debug, info, warning, error.

Starting with 2021.12.3, you can also set the log level to trace. This has no effect on the core authentik server, but shows additional messages for the embedded outpost.

danger

Setting the log level to trace will include sensitive details in logs, so it shouldn't be used in most cases.

Logs generated with trace should be treated with care as they can give others access to your instance, and can potentially include things like session cookies to authentik and other pages.

Defaults to info.

Which domain the session cookie should be set to. By default, the cookie is set to the domain authentik is accessed under.

AUTHENTIK_EVENTS__CONTEXT_PROCESSORS__GEOIP​

Path to the GeoIP City database. Defaults to /geoip/GeoLite2-City.mmdb. If the file is not found, authentik will skip GeoIP support.

AUTHENTIK_EVENTS__CONTEXT_PROCESSORS__ASN​

Path to the GeoIP ASN database. Defaults to /geoip/GeoLite2-ASN.mmdb. If the file is not found, authentik will skip GeoIP support.

AUTHENTIK_DISABLE_UPDATE_CHECK​

Disable the inbuilt update-checker. Defaults to false.

AUTHENTIK_ERROR_REPORTING​

  • AUTHENTIK_ERROR_REPORTING__ENABLED

    Enable error reporting. Defaults to false.

    Error reports are sent to https://sentry.io and are used for debugging and general feedback. Anonymous performance data is also sent.

  • AUTHENTIK_ERROR_REPORTING__SENTRY_DSN

    Sets the DSN for the Sentry API endpoint.

    When error reporting is enabled, the default Sentry DSN will allow the authentik developers to receive error reports and anonymous performance data, which is used for general feedback about authentik, and in some cases, may be used for debugging purposes.

    Users can create their own hosted Sentry account (or self-host Sentry) and opt to collect this data themselves.

  • AUTHENTIK_ERROR_REPORTING__ENVIRONMENT

    The environment tag associated with all data sent to Sentry. Defaults to customer.

    When error reporting has been enabled to aid in debugging issues, this should be set to a unique value, such as an email address.

  • AUTHENTIK_ERROR_REPORTING__SEND_PII

    Whether or not to send personal data, like usernames. Defaults to false.

  • AUTHENTIK_ERROR_REPORTING__EXTRA_ARGS

    Base64-encoded sentry_init arguments. See Sentry's documentation for available options.

AUTHENTIK_EMAIL​

  • AUTHENTIK_EMAIL__HOST

    Default: localhost

  • AUTHENTIK_EMAIL__PORT

    Default: 25

  • AUTHENTIK_EMAIL__USERNAME

    Default: `` (Don't add quotation marks)

  • AUTHENTIK_EMAIL__PASSWORD

    Default: `` (Don't add quotation marks)

  • AUTHENTIK_EMAIL__USE_TLS

    Default: false

  • AUTHENTIK_EMAIL__USE_SSL

    Default: false

  • AUTHENTIK_EMAIL__TIMEOUT

    Default: 10

  • AUTHENTIK_EMAIL__FROM

    Default: authentik@localhost

    Email address authentik will send from, should have a correct @domain

    To change the sender's display name, use a format like Name <account@domain>.

AUTHENTIK_OUTPOSTS​

  • AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE

    Placeholders:

    • %(type)s: Outpost type; proxy, ldap, etc
    • %(version)s: Current version; 2021.4.1
    • %(build_hash)s: Build hash if you're running a beta version

    Placeholder for outpost docker images. Default: ghcr.io/goauthentik/%(type)s:%(version)s.

  • AUTHENTIK_OUTPOSTS__DISCOVER

    Configure the automatic discovery of integrations. Defaults to true.

    By default, the following is discovered:

    • Kubernetes in-cluster config
    • Kubeconfig
    • Existence of a docker socket

AUTHENTIK_LDAP__TASK_TIMEOUT_HOURS authentik 2023.1+​

Timeout in hours for LDAP synchronization tasks.

Defaults to 2.

AUTHENTIK_LDAP__PAGE_SIZE authentik 2023.6.1+​

Page size for LDAP synchronization. Controls the number of objects created in a single task.

Defaults to 50.

AUTHENTIK_LDAP__TLS__CIPHERS authentik 2022.7+​

Allows configuration of TLS Cliphers for LDAP connections used by LDAP sources. Setting applies to all sources.

Defaults to null.

AUTHENTIK_REPUTATION__EXPIRY authentik 2023.8.2+​

Configure how long reputation scores should be saved for in seconds. Note that this is different than AUTHENTIK_REDIS__CACHE_TIMEOUT_REPUTATION, as reputation is saved to the database every 5 minutes.

Defaults to 86400.

AUTHENTIK_SESSION_STORAGE authentik 2024.4+​

Configure if the sessions are stored in the cache or the database. Defaults to cache. Allowed values are cache and db. Note that changing this value will invalidate all previous sessions.

AUTHENTIK_WEB__WORKERS authentik 2022.9+​

Configure how many gunicorn worker processes should be started (see https://docs.gunicorn.org/en/stable/design.html).

Defaults to 2. A value below 2 workers is not recommended. In environments where scaling with multiple replicas of the authentik server is not possible, this number can be increased to handle higher loads.

AUTHENTIK_WEB__THREADS authentik 2022.9+​

Configure how many gunicorn threads a worker processes should have (see https://docs.gunicorn.org/en/stable/design.html).

Defaults to 4.

AUTHENTIK_WORKER__CONCURRENCY authentik 2023.9+​

Configure Celery worker concurrency for authentik worker (see https://docs.celeryq.dev/en/latest/userguide/configuration.html#worker-concurrency). This essentially defines the number of worker processes spawned for a single worker.

Defaults to 2.

AUTHENTIK_WEB__PATH​

info

Requires authentik 2024.8

Configure the path under which authentik is serverd. For example to access authentik under https://my.domain/authentik/, set this to /authentik/. Value must contain both a leading and trailing slash.

Defaults to /.

System settings authentik 2024.2+​

Additional settings are configurable using the Admin interface, under System -> Settings or using the API.

Custom python settings​

To modify additional settings further than the options above allow, you can create a custom Python file and mount it to /data/user_settings.py. This file will be loaded on startup by both the server and the worker. All default settings are here

caution

Using these custom settings is not supported and can prevent your authentik instance from starting. Use with caution.