Skip to content

[Config] [Configuration] Emphasize env vars purpose #18850

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

Merged
merged 1 commit into from
Sep 11, 2023
Merged

[Config] [Configuration] Emphasize env vars purpose #18850

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,15 @@ The values of these options are resolved at runtime (only once per request, to
not impact performance) so you can change the application behavior without having
to clear the cache.

.. note::

Environment variables are designed to store information that can
dynamically change in a production environment, such as an API
key that may have an expiration date. This information could be updated
without having to redeploy the application. Thus, not everything is a good
candidate for env vars, and
:ref:`parameters <configuration-parameters>` should be used in other cases.

This example shows how you could configure the application secret using an env var:

.. configuration-block::
Expand Down