techies/authelia
1
0
Fork 0
mirror of https://github.com/0rangebananaspy/authelia.git synced 2024-09-14 22:47:21 +07:00
Code Issues Projects Releases Wiki Activity

docs: add yaml validation info (#3650)

Browse Source
This commit is contained in:
James Elliott 2022-07-01 12:32:29 +10:00 committed by GitHub
parent 8b58717d4b
commit 1327ec81fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/content/en/configuration/methods/files.md
View File

@ -12,6 +12,15 @@ weight: 101200
toc: true toc: true
--- ---
## Formats
The only supported configuration file format is [YAML](#yaml).
It's important that you sufficiently validate your configuration file. While we produce console errors for users in many
misconfiguration scenarios it's not perfect. Each file type has recommended methods for validation.
### YAML
*Authelia* loads `configuration.yml` as the configuration if you just run it. You can override this behaviour with the *Authelia* loads `configuration.yml` as the configuration if you just run it. You can override this behaviour with the
following syntax: following syntax:
@ -19,6 +28,11 @@ following syntax:
authelia --config config.custom.yml authelia --config config.custom.yml
``` ```
#### YAML Validation
We recommend utilizing [VSCodium](https://vscodium.com/) or [VSCode](https://code.visualstudio.com/), both with the
[YAML Extension](https://open-vsx.org/extension/redhat/vscode-yaml) by RedHat to validate this file type.
## Multiple Configuration Files ## Multiple Configuration Files
You can have multiple configuration files which will be merged in the order specified. If duplicate keys are specified You can have multiple configuration files which will be merged in the order specified. If duplicate keys are specified