authelia/docs/content/en/configuration/second-factor/duo.md

78 lines
2.1 KiB
Markdown
Raw Normal View History

---
title: "Duo / Mobile Push"
description: "Configuring the Duo Mobile Push Notification Second Factor Method."
lead: ""
2022-06-28 05:27:14 +00:00
date: 2022-06-15T17:51:47+10:00
draft: false
images: []
menu:
configuration:
parent: "second-factor"
weight: 103200
toc: true
aliases:
- /docs/configuration/duo-push-notifications.html
---
Authelia supports mobile push notifications relying on [Duo].
Follow the instructions in the dedicated [documentation](../../overview/authentication/push-notification/index.md) for
instructions on 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
{{< config-alert-example >}}
```yaml
duo_api:
disable: false
hostname: api-123456789.example.com
integration_key: ABCDEF
secret_key: 1234567890abcdefghifjkl
enable_self_enrollment: false
```
## Options
This section describes the individual configuration options.
### Disable
{{< confkey type="boolean" default="false" required="no" >}}
Disables Duo. If the hostname, integration_key, and secret_key are all empty strings or undefined this is automatically
true.
### hostname
{{< confkey type="string" required="yes" >}}
The [Duo] API hostname. This is provided in the [Duo] dashboard.
### integration_key
{{< confkey type="string" required="yes" >}}
The non-secret [Duo] integration key. Similar to a client identifier. This is provided in the [Duo] dashboard.
### secret_key
{{< confkey type="string" required="yes" >}}
*__Important Note:__ This can also be defined using a [secret](../methods/secrets.md) which is __strongly recommended__
especially for containerized deployments.*
The secret [Duo] key used to verify your application is valid. This is provided in the [Duo] dashboard.
### enable_self_enrollment
{{< confkey type="boolean" default="false" required="no" >}}
Enables [Duo] device self-enrollment from within the Authelia portal.
[Duo]: https://duo.com/