2020-02-29 07:43:59 +07:00
---
layout: default
title: Notifier
parent: Configuration
2021-06-01 11:09:50 +07:00
nav_order: 8
2020-02-29 07:43:59 +07:00
has_children: true
---
# Notifier
**Authelia** sometimes needs to send messages to users in order to
verify their identity.
[FEATURE] Notifier Startup Checks (#889)
* implement SMTP notifier startup check
* check dial, starttls, auth, mail from, rcpt to, reset, and quit
* log the error on failure
* implement mock
* misc optimizations, adjustments, and refactoring
* implement validate_skip config option
* fix comments to end with period
* fix suites that used smtp notifier without a smtp container
* add docs
* add file notifier startup check
* move file mode into const.go
* disable gosec linting on insecureskipverify since it's intended, warned, and discouraged
* minor PR commentary adjustment
* apply suggestions from code review
Co-Authored-By: Amir Zarrinkafsh <nightah@me.com>
2020-04-21 11:59:38 +07:00
2021-04-11 18:25:03 +07:00
## Configuration
[FEATURE] Notifier Startup Checks (#889)
* implement SMTP notifier startup check
* check dial, starttls, auth, mail from, rcpt to, reset, and quit
* log the error on failure
* implement mock
* misc optimizations, adjustments, and refactoring
* implement validate_skip config option
* fix comments to end with period
* fix suites that used smtp notifier without a smtp container
* add docs
* add file notifier startup check
* move file mode into const.go
* disable gosec linting on insecureskipverify since it's intended, warned, and discouraged
* minor PR commentary adjustment
* apply suggestions from code review
Co-Authored-By: Amir Zarrinkafsh <nightah@me.com>
2020-04-21 11:59:38 +07:00
```yaml
notifier:
disable_startup_check: false
2022-04-03 19:24:51 +07:00
template_path: /path/to/templates/folder
2021-04-11 18:25:03 +07:00
filesystem: {}
smtp: {}
[FEATURE] Notifier Startup Checks (#889)
* implement SMTP notifier startup check
* check dial, starttls, auth, mail from, rcpt to, reset, and quit
* log the error on failure
* implement mock
* misc optimizations, adjustments, and refactoring
* implement validate_skip config option
* fix comments to end with period
* fix suites that used smtp notifier without a smtp container
* add docs
* add file notifier startup check
* move file mode into const.go
* disable gosec linting on insecureskipverify since it's intended, warned, and discouraged
* minor PR commentary adjustment
* apply suggestions from code review
Co-Authored-By: Amir Zarrinkafsh <nightah@me.com>
2020-04-21 11:59:38 +07:00
```
2021-04-11 18:25:03 +07:00
## Options
### disable_startup_check
< 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 >
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:
2022-04-03 19:24:51 +07:00
### template_path
< div markdown = "1" >
type: string
{: .label .label-config .label-purple }
default: ""
{: .label .label-config .label-blue }
required: no
{: .label .label-config .label-green }
< / div >
This option allows the administrator to set custom templates for notifications
the templates folder should contain the following files
|File |Description |
|------------------------|---------------------------------------------------|
|PasswordResetStep1.html |HTML Template for Step 1 of password reset process |
|PasswordResetStep1.txt |Text Template for Step 1 of password reset process |
|PasswordResetStep2.html |HTML Template for Step 2 of password reset process |
|PasswordResetStep2.txt |Text Template for Step 2 of password reset process |
Note:
* if you don't define some of these files, a default template is used for that notification
In template files, you can use the following variables:
|File |Description |
|------------------------|---------------------------------------------------|
|`{{.title}}`| A predefined title for the email. < br > It will be `"Reset your password"` or `"Password changed successfully"` , depending on the current step |
|`{{.url}}` | The url that allows to reset the user password |
|`{{.displayName}}` |The name of the user, i.e. `John Doe` |
|`{{.button}}` |The content for the password reset button, it's hardcoded to `Reset` |
|`{{.remoteIP}}` |The remote IP address that initiated the request or event |
#### Example
```html
< body >
< h1 > {{.title}}< / h1 >
Hi {{.displayName}} < br / >
This email has been sent to you in order to validate your identity
Click < a href = "{{.url}}" > here< / a > to change your password
< / body >
```
2021-04-11 18:25:03 +07:00
### filesystem
The [filesystem ](filesystem.md ) provider.
### smtp
The [smtp ](smtp.md ) provider.
