authelia/docs/configuration/authentication/index.md
James Elliott a2eb0316c8
feat(web): password reset custom url (#3111)
This allows providing a custom URL for password resets. If provided the disable_reset_password option is ignored, the password reset API is disabled, and the button provided in the UI to reset the password redirects users to the configured endpoint.

Closes #1934, Closes #2854

Co-authored-by: you1996 <youssri@flyweight.tech>
2022-04-04 17:46:55 +10:00

1.3 KiB

layout title parent nav_order has_children
default Authentication Backends Configuration 2 true

Authentication Backends

There are two ways to store the users along with their password:

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

Configuration

authentication_backend:
  disable_reset_password: false
  password_reset:
    custom_url: ""
  file: {}
  ldap: {}

Options

disable_reset_password

type: boolean {: .label .label-config .label-purple } default: false {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

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

password_reset

custom_url

type: string {: .label .label-config .label-purple } default: "" {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

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.