rougail-user-data-yaml/README.md
2025-12-29 12:19:08 +01:00

20 lines
2.8 KiB
Markdown

---
gitea: none
include_toc: true
---
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)
## Charge user data from YAML file
> [!NOTE]
>
> **Path**: yaml\
> *`disabled`*\
> **Disabled**: if yaml is not set in "[Select for user datas](#step.user_data)"
| Variable | Description | Default value | Type | Validator |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="yaml.filename" name="yaml.filename">yaml.filename</a>**<br/>**Command line**: <br/>-yf, --yaml.filename<br/>**Environment variable**: YAML.FILENAME | File or directory names where user data are stored.<br/>If a directory is set, all files with &quot;yml&quot; ou &quot;yaml&quot; extension will be load with alphanum order. | | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | `unique`<br/>&nbsp;this filename could be a relative path<br/>&nbsp;this file must exist<br/>&nbsp;file type allowed: "directory" and "file". |
| **<a id="yaml.file_with_secrets" name="yaml.file_with_secrets">yaml.file_with_secrets</a>**<br/>**Command line**: <br/>--yaml.file_with_secrets<br/>**Environment variable**: YAML.FILE_WITH_SECRETS | File that may contain secrets.<br/>By default, all files can contain secrets. It might be useful to define more precisely which files can contain these secrets. | all | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | **Choices**: <br/>&nbsp;all<br/>&nbsp;first<br/>&nbsp;last<br/>&nbsp;none |