summaryrefslogtreecommitdiff
path: root/docs/content/configuration/notifications/introduction.md
blob: 665989a16a14920445ffcf3a4e9ea355c993c5db (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
---
title: "Notifications"
description: "Configuring the Notifications Settings."
summary: "Authelia sends messages to users in order to verify their identity. This section describes how to configure this."
date: 2022-06-15T17:51:47+10:00
draft: false
images: []
weight: 108100
toc: true
seo:
  title: "" # custom title (optional)
  description: "" # custom description (recommended)
  canonical: "" # custom canonical URL (optional)
  noindex: false # false (default) or true
---

Authelia sends messages to users in order to verify their identity.

## Configuration

{{< config-alert-example >}}

```yaml {title="configuration.yml"}
notifier:
  disable_startup_check: false
  template_path: ''
  filesystem: {}
  smtp: {}
```

## Options

This section describes the individual configuration options.

### disable_startup_check

{{< confkey type="boolean" default="false" required="no" >}}

The notifier has a startup check which validates the specified provider configuration is correct and will be able to
send emails. This can be disabled with the `disable_startup_check` option.

### template_path

{{< confkey type="string" required="no" >}}

{{< callout context="note" title="Note" icon="outline/info-circle" >}}
You may configure this directory and add only add the templates you wish to override, any templates not
supplied in this folder will utilize the default templates.
{{< /callout >}}

This option allows the administrator to set a path to a directory where custom templates for notifications can be found.
The specifics are located in the
[Notification Templates Reference Guide](../../reference/guides/notification-templates.md).

### filesystem

The [filesystem](file.md) provider.

### smtp

The [smtp](smtp.md) provider.