mirror of
https://github.com/0rangebananaspy/authelia.git
synced 2024-09-14 22:47:21 +07:00
4710de33a4
This adds to the ongoing effort to remove all pointers to structs in the configuration without breaking backwards compatibility.
98 lines
2.3 KiB
Markdown
98 lines
2.3 KiB
Markdown
---
|
|
layout: default
|
|
title: Duo Push Notifications
|
|
parent: Configuration
|
|
nav_order: 3
|
|
---
|
|
|
|
# Duo Push Notifications
|
|
|
|
Authelia supports mobile push notifications relying on [Duo].
|
|
|
|
Follow the instructions in the dedicated [documentation](../features/2fa/push-notifications.md)
|
|
to know how to set up push notifications in Authelia.
|
|
|
|
**Note:** The configuration options in the following sections are noted as required. They are however only required when
|
|
you have this section defined. i.e. if you don't wish to use the [Duo] push notifications you can just not define this
|
|
section of the configuration.
|
|
|
|
## Configuration
|
|
|
|
The configuration is as follows:
|
|
```yaml
|
|
duo_api:
|
|
disable: false
|
|
hostname: api-123456789.example.com
|
|
integration_key: ABCDEF
|
|
secret_key: 1234567890abcdefghifjkl
|
|
enable_self_enrollment: false
|
|
```
|
|
|
|
The secret key is shown as an example, you also have the option to set it using an environment
|
|
variable as described [here](./secrets.md).
|
|
|
|
## Options
|
|
|
|
### disable:
|
|
<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>
|
|
|
|
Disables Duo. If the hostname, integration_key, and secret_key are all empty strings or undefined this is automatically
|
|
true.
|
|
|
|
### hostname
|
|
<div markdown="1">
|
|
type: string
|
|
{: .label .label-config .label-purple }
|
|
default: ""
|
|
{: .label .label-config .label-blue }
|
|
required: yes
|
|
{: .label .label-config .label-red }
|
|
</div>
|
|
|
|
The [Duo] API hostname supplied by [Duo].
|
|
|
|
### integration_key
|
|
<div markdown="1">
|
|
type: string
|
|
{: .label .label-config .label-purple }
|
|
default: ""
|
|
{: .label .label-config .label-blue }
|
|
required: yes
|
|
{: .label .label-config .label-red }
|
|
</div>
|
|
|
|
The non-secret [Duo] integration key. Similar to a client identifier.
|
|
|
|
### secret_key
|
|
<div markdown="1">
|
|
type: string
|
|
{: .label .label-config .label-purple }
|
|
default: ""
|
|
{: .label .label-config .label-blue }
|
|
required: yes
|
|
{: .label .label-config .label-red }
|
|
</div>
|
|
|
|
The secret [Duo] key used to verify your application is valid.
|
|
|
|
### enable_self_enrollment
|
|
<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>
|
|
|
|
Enables [Duo] device self-enrollment from within the Authelia portal.
|
|
|
|
[Duo]: https://duo.com/
|