From e51740f9c96cb51c3e742df3289b56ce92264925 Mon Sep 17 00:00:00 2001 From: Matto Date: Tue, 19 Oct 2021 23:18:19 +1100 Subject: [PATCH] Added documentation Signed-off-by: Matto --- docs/conf/writing.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/conf/writing.md b/docs/conf/writing.md index 4288d23b17..86b844484b 100644 --- a/docs/conf/writing.md +++ b/docs/conf/writing.md @@ -1,7 +1,6 @@ --- -id: writing -title: Writing Backstage Configuration Files -description: Documentation on Writing Backstage Configuration Files +id: writing title: Writing Backstage Configuration Files description: Documentation on Writing +Backstage Configuration Files --- ## File Format @@ -67,13 +66,15 @@ production build. ## Configuration Files -It is possible to have multiple configuration files, both to support different -environments, but also to define configuration that is local to specific -packages. The configuration files to load are selected using a `--config ` -flag, and it is possible to load any number of files. Paths are relative to the -working directory of the executed process, for example `package/backend`. This -means that to select a config file in the repo root when running the backend, -you would use `--config ../../my-config.yaml`. +It is possible to have multiple configuration files (bundled and/or remote), +both to support different environments, but also to define configuration that is +local to specific packages. The configuration files to load are selected using a +`--config ` flag, and it is possible to load any number of +files. Paths are relative to the working directory of the executed process, for +example `package/backend`. This means that to select a config file in the repo +root when running the backend, you would use `--config ../../my-config.yaml`, +and for config file on a config server you would use +`--config https://some.domain.io/app-config.yaml` If no `config` flags are specified, the default behavior is to load `app-config.yaml` and, if it exists, `app-config.local.yaml` from the repo root. @@ -85,7 +86,7 @@ are NOT loaded. To include them you need to explicitly include them with a flag, for example: ```shell -yarn start --config ../../app-config.yaml --config ../../app-config.staging.yaml +yarn start --config ../../app-config.yaml --config ../../app-config.staging.yaml --config https://some.domain.io/app-config.yaml ``` All loaded configuration files are merged together using the following rules: