Skip to content

Commit d2115ed

Browse files
committed
docs: improve description for namespace separator _
1 parent f7af35e commit d2115ed

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

user_guide_src/source/general/configuration.rst

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,19 @@ prefix followed by a dot (.), and then the variable name itself.
129129
backend.db = admin
130130
BackEnd.db = admin
131131

132+
.. _env-var-namespace-separator:
133+
134+
Namespace Separator
135+
-------------------
136+
137+
Some environments, e.g., Docker, CloudFormation, do not permit variable name with dots (``.``). In such case, since v4.1.5, you could also use underscores (``_``) as a seperator.
138+
139+
::
140+
141+
// namespaced variables with underscore
142+
app_forceGlobalSecureRequests = true
143+
app_CSPEnabled = true
144+
132145
Configuration Classes and Environment Variables
133146
***********************************************
134147

@@ -158,15 +171,13 @@ the value from **.env** replaces the configuration file value.
158171
app.forceGlobalSecureRequests = true
159172
app.CSPEnabled = true
160173

161-
.. note:: When using the *short prefix* the property names must still exactly match the class defined name.
162-
163-
Some environments do not permit variable name with dots. In such case, you could also use ``_`` as a seperator.
164-
165-
::
174+
Since v4.1.5, you can also write with underscores::
166175

167176
app_forceGlobalSecureRequests = true
168177
app_CSPEnabled = true
169178

179+
.. note:: When using the *short prefix* the property names must still exactly match the class defined name.
180+
170181
Environment Variables as Replacements for Data
171182
==============================================
172183

0 commit comments

Comments
 (0)