diff options
Diffstat (limited to 'docs/content/en/configuration')
| -rw-r--r-- | docs/content/en/configuration/methods/files.md | 2 | ||||
| -rw-r--r-- | docs/content/en/configuration/prologue/introduction.md | 5 |
2 files changed, 3 insertions, 4 deletions
diff --git a/docs/content/en/configuration/methods/files.md b/docs/content/en/configuration/methods/files.md index 667d38df3..8793cf889 100644 --- a/docs/content/en/configuration/methods/files.md +++ b/docs/content/en/configuration/methods/files.md @@ -61,7 +61,7 @@ authelia --config configuration.yml,config-acl.yml,config-other.yml ``` Authelia's configuration files use the YAML format. A template with all possible options can be found at the root of the -repository [here](https://github.com/authelia/authelia/blob/master/config.template.yml). +repository {{< github-link name="here" path="config.template.yml" >}}. *__Important Note:__ You should not have configuration sections such as Access Control Rules or OpenID Connect clients configured in multiple files. If you wish to split these into their own files that is fine, but if you have two files that diff --git a/docs/content/en/configuration/prologue/introduction.md b/docs/content/en/configuration/prologue/introduction.md index 76763c33a..586d61935 100644 --- a/docs/content/en/configuration/prologue/introduction.md +++ b/docs/content/en/configuration/prologue/introduction.md @@ -16,9 +16,8 @@ toc: true We document the configuration in two ways: -1. The [YAML] configuration template - [config.template.yml](https://github.com/authelia/authelia/blob/master/config.template.yml) has comments with very - limited documentation on the effective use of a particular option. All documentation lines start with `##`. Lines +1. The [YAML] configuration template {{< github-link path="config.template.yml" >}} has comments with very limited + documentation on the effective use of a particular option. All documentation lines start with `##`. Lines starting with a single `#` are [YAML] configuration options which are commented to disable them or as examples. 2. This documentation site. Generally each section of the configuration is in its own section of the documentation site. Each configuration option is listed in its relevant section as a heading, under that heading generally are two |