Merge pull request #2710 from taras/tm/add-message-about-local

Add Local Configuration to Development Environment page
2020-10-05 21:49:35 +02:00
parent bf60b84d99 65a06ce1e8
commit da03842a42
1 changed files with 14 additions and 0 deletions
@@ -88,3 +88,17 @@ yarn create-plugin # Create a new plugin
 > See
 > [package.json](https://github.com/spotify/backstage/blob/master/package.json)
 > for other yarn commands/options.
+
+## Local configuration
+
+Backstage allows you to specify the configuration used while running the
+application on your computer. Local configuration is read from
+`app-config.local.yaml`. This file is ignored by Git, which means that you can
+safely use it to reference secrets like GitHub tokens without worrying about
+these secrets, inadvertently ending up in the Git repository. You do not need to
+copy everything from the default config to the local config.
+`app-config.local.yaml` will be merged with `app-config.yaml` and overwrite the
+default app configs.
+
+You can learn more about the local configuration in
+[Static Configuration in Backstage](../conf/) section.