From eab31f0b0f28b8612d47e5586c3c110f7888bb4a Mon Sep 17 00:00:00 2001 From: Alexandre Daubois Date: Fri, 8 Sep 2023 13:13:24 +0200 Subject: [PATCH] [Configuration] Emphasize env vars purpose --- configuration.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/configuration.rst b/configuration.rst index f201fab29fb..75663f992d9 100644 --- a/configuration.rst +++ b/configuration.rst @@ -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 ` should be used in other cases. + This example shows how you could configure the application secret using an env var: .. configuration-block::