Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Environment variables documentation #1089

Merged
merged 3 commits into from
Sep 19, 2024
Merged

Environment variables documentation #1089

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
656c53f
Created environment variables documentation
Sep 10, 2024
93d21c0
Removed table + Listed variable names under respective sections
Sep 10, 2024
3388eed
Removed individually listed environment variables
Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/dev/back/config_environment_variables.md
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the whole point of having searches instead of listing out a table was because the table will quickly become obsolete and gives people a false sense of knowledge. Please remove.

Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Configuring Environment Variables

## 1. List of Environment Variables

### DB, WEBSERVER, PUSH Config
Use this [search](https://github.com/search?q=repo%3Ae-mission%2Fe-mission-server%20config.get&type=code) to obtain usage of `DB, WEBSERVER, PUSH` environment variables.

#### Environment variables:
DB config: <br>DB_HOST, DB_RESULT_LIMIT<br><br>
WEBSERVER config: <br>WEB_SERVER_HOST, WEBSERVER_PORT, WEBSERVER_TIMEOUT, WEBSERVER_NOT_FOUND_REDIRECT, WEBSERVER_AUTH, WEBSERVER_AGGREGATE_CALL_AUTH<br><br>
PUSH config: <br>PUSH_PROVIDER, PUSH_SERVER_AUTH_TOKEN, PUSH_APP_PACKAGE_NAME, PUSH_IOS_TOKEN_FORMAT<br><br>

### AWS Cognito Credentials

#### Environment variables:
COGNITO_CLIENT_ID, COGNITO_CLIENT_SECRET, COGNITO_REDIRECT_URL, COGNITO_TOKEN_ENDPOINT, COGNITO_USER_POOL_ID, COGNITO_REGION, COGNITO_AUTH_URL

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 admin-dashboard repository.

### Overpass, Nominatim

#### Environment variables:
GFBK_KEY, GEOFABRIK_OVERPASS_KEY, NOMINATIM_QUERY_URL, OPENSTREETMAP_QUERY_URL, GEOFABRIK_QUERY_URL, NOMINATIM_CONTAINER_URL

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.

This [search](https://github.com/search?q=repo%3Ae-mission%2Fe-mission-server+geofabrik&type=code) shows that some variables are set using GitHub secrets in the e-mission-server GitHub workflows: GEOFABRIK_API, GEOFABRIK_OVERPASS_KEY.