paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 28 Packages Projects Releases Wiki Activity

Added documentation

Browse Source 
Signed-off-by: Matto <muhamadto@gmail.com>
This commit is contained in:
Matto
2021-10-19 23:18:19 +11:00
parent 5d4053c827
commit e51740f9c9
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/conf/writing.md
+12 -11
View File
@@ -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 <path>`
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 <local-path|url>` 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: