First Factor

There are two ways to integrate Authelia with an authentication backend:

• LDAP: users are stored in remote servers like OpenLDAP, OpenDJ, FreeIPA, or Microsoft Active Directory.
• File: users are stored in YAML file with a hashed version of their password.

Configuration

{{< config-alert-example >}}

authentication_backend:
  refresh_interval: '5m'
  password_reset:
    disable: false
    custom_url: ''
  password_change:
    disable: false

Options

This section describes the individual configuration options.

refresh_interval

{{< confkey type="string,integer" syntax="duration" default="5 minutes" required="no">}}

{{< callout context="note" title="Note" icon="outline/info-circle" >}} When using the File Provider this value has a default value of always as the cost in this scenario is basically not measurable, users can, however, override this setting by setting an explicit value. {{< /callout >}}

This setting controls the interval at which details are refreshed from the backend. The details refreshed in order of importance are the groups, email address, and display name. This is particularly useful for the File Provider when watch is enabled or generally with the LDAP Provider.

In addition to the duration values this option accepts always and disable as values; where always will always refresh this value, and disable will never refresh the profile.

password_reset

disable

{{< confkey type="boolean" default="false" required="no" >}}

This setting controls if users can reset their password from the web frontend or not.

custom_url

{{< confkey type="string" required="no" >}}

The custom password reset URL. This replaces the inbuilt password reset functionality and disables the endpoints if this is configured to anything other than nothing or an empty string.

password_change

disable

{{< confkey type="boolean" default="false" required="no" >}}

This setting controls if users can change their password from the web frontend or not.

file

The file authentication provider.

ldap

The LDAP authentication provider.