rougail-user-data-environment/README.md

---
gitea: none
include_toc: true
---
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)

## Load environment variables

> [!NOTE]
> 
> Variable values can be defined directly from an environment variable.\n\Environnement variable names begin with a prefix (by default ROUGAIL_) followed by the variable path in uppercase, for example: ROUGAIL_MY_VARIABLE. If you are using namespaces, the prefix is the name of the namespace in uppercase.\n\nNote that variable paths can contain ("."), which are not permitted everywhere. To avoid any issues, use the `env` command, for example: env ROUGAIL_MY_FAMILY.MY_VARIABLE=1 rougail\n\nFor values, there is no difference between a number and a letter (they can be enclosed in quotes or not). However, booleans are True or False. The separator for multiple variables is a comma.\
> **Path**: environment\
> *`disabled`*\
> **Disabled**: if environment is not set in "[Select for user datas](#step.user_data)"

| Variable                                                                                                                                                                                                                                                                   | Description                                                                                                                           | Default value   | Type                                                                                            | Validator                            |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|--------------------------------------|
| **<a id="environment.default_environment_name" name="environment.default_environment_name">environment.default_environment_name</a>**<br/>**Command line**: <br/>--environment.default_environment_name<br/>**Environment variable**: ENVIRONMENT.DEFAULT_ENVIRONMENT_NAME | Name of the default environment prefix.                                                                                               | ROUGAIL         | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`  | Should only use uppercase character. |
| **<a id="environment.custom_separator" name="environment.custom_separator">environment.custom_separator</a>**<br/>**Command line**: <br/>--environment.custom_separator<br/>**Environment variable**: ENVIRONMENT.CUSTOM_SEPARATOR                                         | Replace the separator character &quot;.&quot; in path by an other.<br/>The &quot;.&quot; character could be not allowed in path name. |                 | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)              |                                      |
| **<a id="environment.with_secrets" name="environment.with_secrets">environment.with_secrets</a>**<br/>**Command line**: <br/>•&nbsp;--environment.with_secrets<br/>•&nbsp;--environment.no-with_secrets<br/>**Environment variable**: ENVIRONMENT.WITH_SECRETS             | Environnement variables may contain secrets.                                                                                          | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |                                      |