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.

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

Add documentation about environment variables #2314

Merged
merged 1 commit into from
Aug 17, 2023

Conversation

floehopper
Copy link
Contributor

@floehopper floehopper commented Aug 17, 2023

While I was working on #2311, I thought it would be useful to document the environment-variables used in the app. I think these are all the environment variables that are specific to this app or at least have an app-specific use in this app, but I might have missed some.

It would be nice to work out which ones are required in which environments, but that's a non-trivial amount of work, because the app doesn't seem to fail fast for at least some of the required ones.

Note that I haven't included env vars which are used as arguments to rake tasks or scripts.

I think these are all the environment variables that are specific to
this app or at least have an app-specific use in this app.
Copy link
Contributor

@chrisroos chrisroos left a comment

Choose a reason for hiding this comment

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

I've not checked each variable but I trust that you've done that so this looks good to me, @floehopper 👍

@floehopper floehopper merged commit 2b935d7 into main Aug 17, 2023
7 checks passed
@floehopper floehopper deleted the document-environment-variables branch August 17, 2023 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants