Redis

This is a session provider. By default Authelia uses an in-memory provider. Not configuring redis leaves Authelia stateful. It’s important in highly available scenarios to configure this option and we highly recommend it in production environments. It requires you setup redis as well.

Configuration#

session:
  redis:
    host: '127.0.0.1'
    port: 6379
    username: 'authelia'
    password: 'authelia'
    database_index: 0
    maximum_active_connections: 8
    minimum_idle_connections: 0
    tls:
      server_name: 'myredis.example.com'
      skip_verify: false
      minimum_version: 'TLS1.2'
      maximum_version: 'TLS1.3'
      certificate_chain: |
        -----BEGIN CERTIFICATE-----
        ...
        -----END CERTIFICATE-----
        -----BEGIN CERTIFICATE-----
        ...
        -----END CERTIFICATE-----        
      private_key: |
        -----BEGIN RSA PRIVATE KEY-----
        ...
        -----END RSA PRIVATE KEY-----        
    high_availability:
      sentinel_name: 'mysentinel'
      # If `sentinel_username` is supplied, Authelia will connect using ACL-based
      # authentication. Otherwise, it will use traditional `requirepass` auth.
      sentinel_username: 'sentinel_user'
      sentinel_password: 'sentinel_specific_pass'
      nodes:
        - host: 'sentinel-node1'
          port: 26379
        - host: 'sentinel-node2'
          port: 26379
      route_by_latency: false
      route_randomly: false

Options#

This section describes the individual configuration options.

host#

The redis host or unix socket path. If utilising an IPv6 literal address it must be enclosed by square brackets and quoted:

host: '[fd00:1111:2222:3333::1]'

port#

The port redis is listening on.

username#

The username for redis authentication. Only supported in redis 6.0+, and redis currently offers backwards compatibility with password-only auth. You probably do not need to set this unless you went through the process of setting up redis ACLs.

password#

Important Note: This can also be defined using a secret which is strongly recommended especially for containerized deployments.

The password for redis authentication.

It’s strongly recommended this is a Random Alphanumeric String with 64 or more characters and the user password is changed to this value.

database_index#

The index number of the redis database, the same value as specified with the redis SELECT command.

maximum_active_connections#

The maximum connections open to redis at the same time.

minimum_idle_connections#

The minimum number of redis connections to keep open as long as they don’t exceed the maximum active connections. This is useful if there are long delays in establishing connections.

tls#

If defined enables connecting to redis over a TLS socket, and additionally controls the TLS connection validation parameters.

high_availability#

When defining this session it enables redis sentinel connections. It’s possible in the future we may add redis cluster.

sentinel_name#

The redis sentinel master name. This is defined in your redis sentinel configuration, it is not a hostname. This must be defined currently for a high availability configuration.

sentinel_username#

The username for the redis sentinel connection. If this is provided, it will be used along with the sentinel_password for ACL-based authentication to the Redis Sentinel. If only a password is provided, the redis sentinel connection will be authenticated with traditional requirepass authentication.

sentinel_password#

Important Note: This can also be defined using a secret which is strongly recommended especially for containerized deployments.

The password for the redis sentinel connection. If specified with sentinel_username, configures Authelia to authenticate to the Redis Sentinel with ACL-based authentication. Otherwise, this is used for requirepass authentication.

It’s strongly recommended this is a Random Alphanumeric String with 64 or more characters and the user password is changed to this value.

nodes#

A list of redis sentinel nodes to load balance over. This list is added to the host in the redis section above. It is required you either define the redis host or one redis sentinel node. The redis host must be a redis sentinel host, not a regular one. The individual redis hosts are determined using redis sentinel commands.

Each node has a host and port configuration. Example:

- host: redis-sentinel-0
  port: 26379

host#

The host of this redis sentinel node.

port#

The port of this redis sentinel node.

route_by_latency#

Prioritizes low latency redis sentinel nodes when set to true.

route_randomly#

Randomly chooses redis sentinel nodes when set to true.