mirror of https://github.com/0rangebananaspy/authelia.git synced 2024-09-14 22:47:21 +07:00

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

814 B

Raw Blame History

layout	title	parent	nav_order	has_children
default	Notifier	Configuration	6	true

Notifier

Authelia sometimes needs to send messages to users in order to verify their identity.

Configuration

notifier:
  disable_startup_check: false
  filesystem: {}
  smtp: {}

Options

disable_startup_check

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

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 provider.

smtp

The smtp provider.

814 B Raw Blame History