authelia/docs/configuration/duo-push-notifications.md
James Elliott 4710de33a4
refactor(configuration): remove ptr for duoapi and notifier (#3200)
This adds to the ongoing effort to remove all pointers to structs in the configuration without breaking backwards compatibility.
2022-04-16 09:34:26 +10:00

2.3 KiB

layout title parent nav_order
default Duo Push Notifications Configuration 3

Duo Push Notifications

Authelia supports mobile push notifications relying on Duo.

Follow the instructions in the dedicated documentation 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:

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.

Options

disable:

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

Disables Duo. If the hostname, integration_key, and secret_key are all empty strings or undefined this is automatically true.

hostname

type: string {: .label .label-config .label-purple } default: "" {: .label .label-config .label-blue } required: yes {: .label .label-config .label-red }

The Duo API hostname supplied by Duo.

integration_key

type: string {: .label .label-config .label-purple } default: "" {: .label .label-config .label-blue } required: yes {: .label .label-config .label-red }

The non-secret Duo integration key. Similar to a client identifier.

secret_key

type: string {: .label .label-config .label-purple } default: "" {: .label .label-config .label-blue } required: yes {: .label .label-config .label-red }

The secret Duo key used to verify your application is valid.

enable_self_enrollment

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

Enables Duo device self-enrollment from within the Authelia portal.