RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
Aram Akhavan 2021-12-01 21:50:05 -07:00 committed by GitHub
parent a79e4dc592
commit 5b3fa1fffb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
config.template.yml
View File

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

7
docs/configuration/index.md
View File

@ -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

2
internal/configuration/config.template.yml
View File

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