2020-02-29 07:43:59 +07:00
|
|
|
---
|
|
|
|
layout: default
|
2021-08-02 18:55:30 +07:00
|
|
|
title: Authentication Backends
|
2020-02-29 07:43:59 +07:00
|
|
|
parent: Configuration
|
2021-08-02 18:55:30 +07:00
|
|
|
nav_order: 2
|
2020-02-29 07:43:59 +07:00
|
|
|
has_children: 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.
|
2020-04-05 06:28:09 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Configuration
|
2020-04-05 06:28:09 +07:00
|
|
|
|
|
|
|
```yaml
|
|
|
|
authentication_backend:
|
2021-04-11 18:25:03 +07:00
|
|
|
disable_reset_password: false
|
2022-04-04 14:46:55 +07:00
|
|
|
password_reset:
|
|
|
|
custom_url: ""
|
2021-04-11 18:25:03 +07:00
|
|
|
file: {}
|
|
|
|
ldap: {}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Options
|
|
|
|
|
|
|
|
### disable_reset_password
|
|
|
|
<div markdown="1">
|
|
|
|
type: boolean
|
|
|
|
{: .label .label-config .label-purple }
|
|
|
|
default: false
|
|
|
|
{: .label .label-config .label-blue }
|
|
|
|
required: no
|
|
|
|
{: .label .label-config .label-green }
|
|
|
|
</div>
|
|
|
|
|
|
|
|
This setting controls if users can reset their password from the web frontend or not.
|
|
|
|
|
2022-04-04 14:46:55 +07:00
|
|
|
### password_reset
|
|
|
|
|
|
|
|
#### custom_url
|
|
|
|
<div markdown="1">
|
|
|
|
type: string
|
|
|
|
{: .label .label-config .label-purple }
|
|
|
|
default: ""
|
|
|
|
{: .label .label-config .label-blue }
|
|
|
|
required: no
|
|
|
|
{: .label .label-config .label-green }
|
|
|
|
</div>
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
### file
|
|
|
|
|
|
|
|
The [file](file.md) authentication provider.
|
|
|
|
|
|
|
|
### ldap
|
|
|
|
|
|
|
|
The [LDAP](ldap.md) authentication provider.
|