docs: consistent naming for configuration file (#2626)
* change all instances (file names and docs) of "config.template.yml" to "configuration.template.yml" so its consistent with the expectations of the Dockerfile * Keep config.template.yml named as is Co-authored-by: Amir Zarrinkafsh <nightah@me.com> * Update index.html * revert filename changes and add a note about docker * refactor: apply suggestions from code review Co-authored-by: Amir Zarrinkafsh <nightah@me.com>pull/2660/head^2
parent
a79e4dc592
commit
5b3fa1fffb
|
@ -354,4 +354,4 @@ for providing us with free licenses to their great tools.
|
||||||
[Kubernetes]: https://kubernetes.io/
|
[Kubernetes]: https://kubernetes.io/
|
||||||
[security]: https://github.com/authelia/authelia/security/policy
|
[security]: https://github.com/authelia/authelia/security/policy
|
||||||
[#support]: https://discord.com/channels/707844280412012608/707844280412012612
|
[#support]: https://discord.com/channels/707844280412012608/707844280412012612
|
||||||
[#contributing]: https://discord.com/channels/707844280412012608/804943261265297408
|
[#contributing]: https://discord.com/channels/707844280412012608/804943261265297408
|
||||||
|
|
|
@ -4,6 +4,8 @@
|
||||||
# Authelia Configuration #
|
# Authelia Configuration #
|
||||||
###############################################################################
|
###############################################################################
|
||||||
|
|
||||||
|
## Note: the container by default expects to find this file at /config/configuration.yml.
|
||||||
|
|
||||||
## Certificates directory specifies where Authelia will load trusted certificates (public portion) from in addition to
|
## Certificates directory specifies where Authelia will load trusted certificates (public portion) from in addition to
|
||||||
## the system certificates store.
|
## the system certificates store.
|
||||||
## They should be in base64 format, and have one of the following extensions: *.cer, *.crt, *.pem.
|
## They should be in base64 format, and have one of the following extensions: *.cer, *.crt, *.pem.
|
||||||
|
|
|
@ -27,13 +27,16 @@ You can have multiple configuration files which will be merged in the order spec
|
||||||
the last one to be specified is the one that takes precedence. Example:
|
the last one to be specified is the one that takes precedence. Example:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ authelia --config config.yml --config config-acl.yml --config config-other.yml
|
$ authelia --config configuration.yml --config config-acl.yml --config config-other.yml
|
||||||
$ authelia --config config.yml,config-acl.yml,config-other.yml
|
$ 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
|
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 [here](https://github.com/authelia/authelia/blob/master/config.template.yml).
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
By default, the container looks for a configuration file at `/config/configuration.yml`. This can be changed using the `command` setting.
|
||||||
|
|
||||||
## Environment
|
## Environment
|
||||||
You may also provide the configuration by using environment variables. Environment variables are applied after the
|
You may also provide the configuration by using environment variables. Environment variables are applied after the
|
||||||
configuration file meaning anything specified as part of the environment overrides the configuration files. The
|
configuration file meaning anything specified as part of the environment overrides the configuration files. The
|
||||||
|
|
|
@ -4,6 +4,8 @@
|
||||||
# Authelia Configuration #
|
# Authelia Configuration #
|
||||||
###############################################################################
|
###############################################################################
|
||||||
|
|
||||||
|
## Note: the container by default expects to find this file at /config/configuration.yml.
|
||||||
|
|
||||||
## Certificates directory specifies where Authelia will load trusted certificates (public portion) from in addition to
|
## Certificates directory specifies where Authelia will load trusted certificates (public portion) from in addition to
|
||||||
## the system certificates store.
|
## the system certificates store.
|
||||||
## They should be in base64 format, and have one of the following extensions: *.cer, *.crt, *.pem.
|
## They should be in base64 format, and have one of the following extensions: *.cer, *.crt, *.pem.
|
||||||
|
|
|
@ -135,4 +135,4 @@
|
||||||
</pre>
|
</pre>
|
||||||
</body>
|
</body>
|
||||||
|
|
||||||
</html>
|
</html>
|
||||||
|
|
Loading…
Reference in New Issue