authelia/docs/configuration/notifier/index.md
James Elliott 08e674b62f
docs: refactor several areas of documentation (#1726)
Updated all links to use https://www.authelia.com/docs/.
Removed all comment sections from documented configuration on the documentation site and replaced them with their own sections.
Made all documentation inside config.template.yml double hashes, and made all commented configuration sections single quoted.
Added .yamllint.yaml to express our desired YAML styles.
Added a style guide.
Refactored many documentation areas to be 120 char widths where possible. It's by no means exhaustive but is a large start.
Added a statelessness guide for the pending Kubernetes chart introduction.
Added labels to configuration documentation and made many areas uniform.
2021-04-11 21:25:03 +10:00

46 lines
814 B
Markdown

---
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.
## Configuration
```yaml
notifier:
disable_startup_check: false
filesystem: {}
smtp: {}
```
## 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.