[doc]Added advice for production env variables #6374
Conversation
|
Hi @ObjectiveTruth, Thank you for your contribution! We really value the time you've taken to put this together. Before we proceed with reviewing this pull request, please sign the Typesafe Contributors License Agreement: |
|
|
||
| Here, the override field `my.key = ${?MY_KEY_ENV}` simply vanishes if there's no value for `MY_KEY_ENV`, but if you set an environment variable `MY_KEY_ENV` for example, it would be used. | ||
|
|
||
| Because you can reference variables from withing other variables, ensure you don't name your environmental variable the same as the field name. |
|
Is it worth mentioning this other special case? https://github.com/typesafehub/config#note-about-resolving-substitutions-in-referenceconf-and-applicationconf |
I don't think so, because that's more a best practice than a gotcha. If the user is expecting support for programmatic operations in their |
Had an issue that seemed silly, so I updated the docs with it explicitly. Basically you can't name your Env variables the same as the variables
Pull Request Checklist
Helpful things
Fixes
Fixes #xxxx
Purpose
What does this PR do?
Background Context
Why did you take this approach?
References
Are there any relevant issues / PRs / mailing lists discussions?
Had an issue that seemed silly, so I updated the docs with it explicitly. Basically you can't name your Env variables the same as the variables