2020-02-29 07:43:59 +07:00
|
|
|
---
|
|
|
|
layout: default
|
|
|
|
title: Notifier
|
|
|
|
parent: Configuration
|
|
|
|
nav_order: 6
|
|
|
|
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
|
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:
|
|
|
|
|
|
|
|
### filesystem
|
|
|
|
|
|
|
|
The [filesystem](filesystem.md) provider.
|
|
|
|
|
|
|
|
### smtp
|
|
|
|
|
|
|
|
The [smtp](smtp.md) provider.
|