From 5b3fa1fffb82cf7a5f4ba11ce151e16b929a6e34 Mon Sep 17 00:00:00 2001 From: Aram Akhavan Date: Wed, 1 Dec 2021 21:50:05 -0700 Subject: [PATCH] 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 * Update index.html * revert filename changes and add a note about docker * refactor: apply suggestions from code review Co-authored-by: Amir Zarrinkafsh --- README.md | 2 +- config.template.yml | 2 ++ docs/configuration/index.md | 7 +++++-- internal/configuration/config.template.yml | 2 ++ .../example/compose/nginx/backend/html/home/index.html | 2 +- 5 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8cf1debd0..974ee6b02 100644 --- a/README.md +++ b/README.md @@ -354,4 +354,4 @@ for providing us with free licenses to their great tools. [Kubernetes]: https://kubernetes.io/ [security]: https://github.com/authelia/authelia/security/policy [#support]: https://discord.com/channels/707844280412012608/707844280412012612 -[#contributing]: https://discord.com/channels/707844280412012608/804943261265297408 \ No newline at end of file +[#contributing]: https://discord.com/channels/707844280412012608/804943261265297408 diff --git a/config.template.yml b/config.template.yml index e0dc2e257..471cd1478 100644 --- a/config.template.yml +++ b/config.template.yml @@ -4,6 +4,8 @@ # 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 ## the system certificates store. ## They should be in base64 format, and have one of the following extensions: *.cer, *.crt, *.pem. diff --git a/docs/configuration/index.md b/docs/configuration/index.md index db0696da6..7e346c438 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -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: ```console -$ authelia --config config.yml --config config-acl.yml --config config-other.yml -$ authelia --config config.yml,config-acl.yml,config-other.yml +$ authelia --config configuration.yml --config config-acl.yml --config 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 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 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 diff --git a/internal/configuration/config.template.yml b/internal/configuration/config.template.yml index e0dc2e257..471cd1478 100644 --- a/internal/configuration/config.template.yml +++ b/internal/configuration/config.template.yml @@ -4,6 +4,8 @@ # 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 ## the system certificates store. ## They should be in base64 format, and have one of the following extensions: *.cer, *.crt, *.pem. diff --git a/internal/suites/example/compose/nginx/backend/html/home/index.html b/internal/suites/example/compose/nginx/backend/html/home/index.html index 2eea68025..509b8709c 100644 --- a/internal/suites/example/compose/nginx/backend/html/home/index.html +++ b/internal/suites/example/compose/nginx/backend/html/home/index.html @@ -135,4 +135,4 @@ - \ No newline at end of file +