summaryrefslogtreecommitdiff
path: root/docs/content/configuration/second-factor/duo.md
blob: cccc69891feb664fbc7247cb9f24e9a1d99deaf0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
---
title: "Duo / Mobile Push"
description: "Configuring the Duo Mobile Push Notification Second Factor Method."
summary: ""
date: 2022-06-15T17:51:47+10:00
draft: false
images: []
weight: 103200
toc: true
aliases:
  - /docs/configuration/duo-push-notifications.html
seo:
  title: "" # custom title (optional)
  description: "" # custom description (recommended)
  canonical: "" # custom canonical URL (optional)
  noindex: false # false (default) or true
---

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.

{{< callout context="note" title="Note" icon="outline/info-circle" >}}
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](https://duo.com/) push notifications, you can just not define this
section of the configuration.
{{< /callout >}}

## Configuration

{{< config-alert-example >}}

```yaml {title="configuration.yml"}
duo_api:
  disable: false
  hostname: 'api-123456789.{{< sitevar name="domain" nojs="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" secret="yes" >}}

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/