From 29cc1e68c2e287710b7572bf8e0a31f6d33f872f Mon Sep 17 00:00:00 2001 From: Mukul Chandrakant Mahadik Date: Wed, 18 Sep 2024 18:05:50 -0700 Subject: [PATCH] Environment variables documentation (#1089) * Created environment variables documentation * Removed table + Listed variable names under respective sections * Removed individually listed environment variables If included, then it won't be up-to-date if we update / remove variables and will need to update this everytime. Hence removing the specific names of environment variables. --------- Co-authored-by: Mahadik, Mukul Chandrakant --- docs/dev/back/config_environment_variables.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/dev/back/config_environment_variables.md diff --git a/docs/dev/back/config_environment_variables.md b/docs/dev/back/config_environment_variables.md new file mode 100644 index 0000000..141cd2e --- /dev/null +++ b/docs/dev/back/config_environment_variables.md @@ -0,0 +1,15 @@ +# Configuring Environment Variables + +The search results below identify some environment variables that need to be manually configured. + +#### DB, Webserver, Push Config +- Use this [search](https://github.com/search?q=repo%3Ae-mission%2Fe-mission-server+%2Fconfig.get%5C%28%5C%22%5BA-Z%5D%2F&type=code) to obtain usage of `DB, WEBSERVER, PUSH` environment variables in the [e-mission-server](https://github.com/e-mission/e-mission-server) repository. + +#### AWS Cognito Credentials + +- Use this [search](https://github.com/search?q=repo%3Ae-mission%2Fop-admin-dashboard+%2F.getenv%5C%28%5C%22%5BA-Z%5D%2F&type=code) to obtain usage of `COGNITO` variables in the [admin-dashboard](https://github.com/e-mission/op-admin-dashboard) repository. + +#### Overpass, Nominatim, Geofabrik + +- Use this [search](https://github.com/search?q=repo%3Ae-mission%2Fe-mission-server+%2F.environ.get%5C%28%5C%22%5BA-Z%5D%2F&type=code) to obtain usage of `Overpass, Nominatim, Geofabrik` environment variables in the [e-mission-server](https://github.com/e-mission/e-mission-server) repository. +- Use this [search](https://github.com/search?q=repo%3Ae-mission%2Fe-mission-server+geofabrik&type=code) to view some variables that are set using GitHub secrets in the [e-mission-server](https://github.com/e-mission/e-mission-server) GitHub workflows. \ No newline at end of file