Miscellaneous

Configuration

Example Configuration

This section is intended as an example configuration to help users with a rough contextual layout of this configuration section, it is not intended to explain the options. The configuration shown may not be a valid configuration, and you should see the options section below and the navigation links to properly understand each option individually.

configuration.yml
certificates_directory: '/config/certs/'
default_redirection_url: 'https://home.example.com:8080/'
theme: 'light'

Options

This section describes the individual configuration options.

certificates_directory

By default Authelia uses the system certificate trust for TLS certificate verification but you can augment this with this option which forms the foundation for trusting TLS connections within Authelia. Most if not all TLS connections have the server TLS certificate verified using this augmented certificate trust store.

This option specifically specifies a directory path which may contain one or more certificates encoded in the X.509 PEM format. The certificates themselves must have extension .pem, .crt, or .cer.

These certificates can either be the CA public key which trusts the given certificate and any certificate signed by it, or a specific individual leaf certificate.

default_redirection_url

string not required

Important Note

You should configure the domain-specific redirection URL’s in the session configuration instead of using this option.

The default redirection URL is the URL where users are redirected when Authelia cannot detect the target URL where the user was heading.

In a normal authentication workflow, a user tries to access a website and they get redirected to the sign-in portal in order to authenticate. Since the user initially targeted a website, the portal knows where the user was heading and can redirect them after the authentication process. However, when a user visits the sign in portal directly, the portal considers the targeted website is the portal. In that case and if the default redirection URL is configured, the user is redirected to that URL. If not defined, the user is not redirected after authentication.

default_2fa_method

string totp not required

Sets the default second factor method for users. This must be blank or one of the enabled methods. New users will by default have this method selected for them. In addition if this was configured to webauthn and a user had the totp method, and the totp method was disabled in the configuration, the users’ method would automatically update to the webauthn method.

Options are:

  • totp
  • webauthn
  • mobile_push
configuration.yml
default_2fa_method: totp

theme

string light not required

There are currently 3 available themes for Authelia:

  • light (default)
  • dark
  • grey

To enable automatic switching between themes, you can set theme to auto. The theme will be set to either dark or light depending on the user’s system preference which is determined using media queries. To read more technical details about the media queries used, read the MDN.