authelia/docs/content/configuration/first-factor/introduction.md

2.8 KiB

title name description summary date draft images weight toc aliases seo
First Factor test Configuring Authelia First Factor Authentication. Authelia uses a username and password for a first factor method. This section describes configuring this. 2022-06-15T17:51:47+10:00 false
102100 true
/c/1fa
/docs/configuration/authentication/
title description canonical noindex
false

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

Configuration

{{< config-alert-example >}}

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

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.

file

The file authentication provider.

ldap

The LDAP authentication provider.