📝 [open-zaak/open-zaak#1649] Document envvars #174
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stevenbal
commented
Jul 23, 2024
Comment on lines
-31
to
-38
| **Docker** | ||
|
|
||
| Additionally, the following optional envvars MUST be set/changed when running | ||
| on Docker, since ``localhost`` is contained within the container: | ||
|
|
||
| * ``CACHE_DEFAULT`` | ||
| * ``CACHE_AXES`` | ||
| * ``EMAIL_HOST`` |
There was a problem hiding this comment.
I should probably look into a way to restore this
There was a problem hiding this comment.
I added these variables to the required group and explained that they are required for docker in the help text: maykinmedia/open-api-framework#62
5 tasks
stevenbal
force-pushed
the
feature/envvar-documentation
branch
4 times, most recently
from
eabfc87
to
341c947
Compare
replace the manual envvar docs with OAf `generate_envvar_docs`, this ensure that generic envvars that are used by every component are documented centrally in OAF and custom envvars can be documented in the code where they are declared
stevenbal
force-pushed
the
feature/envvar-documentation
branch
from
341c947
to
12ad3cc
Compare
annashamray
approved these changes
Aug 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes open-zaak/open-zaak#1649 partially
Changes