Correct README description of config file keys #489
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
The README says the conversion between flag name / env var name and the key used for file-based configuration is simple replacement of _ with . -- this is not true in many, if not most, cases (not just the STORAGE flag). This is demonstrated even in the example that immediately follows the text: authrealm, not auth.realm for AUTH_REALM, bearerauth for BEARER_AUTH, and so on. Further confounding the user, there is no indication (even with debug on) that the config file contains keys that don't map to any flags. Signed-off-by: Max Timchenko <[email protected]>
maxvt-tonal
force-pushed
the
correct-readme-for-config-file-use
branch
from
1dfbf98 to
2170597
Compare
jdolitsky
approved these changes
Jan 19, 2022
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.
The README says the conversion between flag name / env var name
and the key used for file-based configuration is simple replacement
of _ with . -- this is not true in many, if not most, cases
(not just the STORAGE flag).
This is demonstrated even in the example that immediately follows
the text: authrealm, not auth.realm for AUTH_REALM, bearerauth for
BEARER_AUTH, and so on.
Further confounding the user, there is no indication (even with debug
on) that the config file contains keys that don't map to any flags.