From 91d7c18e6c735802f830cfebbab7751d9d7fd03d Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Wed, 23 Oct 2024 20:01:47 +0200 Subject: [PATCH] [tutorial 061] A variable with multiple value (config and doc) --- README.md | 39 ++++++++++++++++++++++++++++++++------- config/02/config.yaml | 4 +++- config/02/output_ro.html | 4 +++- config/03/config.yaml | 3 +++ config/03/output_ro.html | 4 ++++ 5 files changed, 45 insertions(+), 9 deletions(-) create mode 100644 config/03/config.yaml create mode 100644 config/03/output_ro.html diff --git a/README.md b/README.md index 8f9918e..8c84c0d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial 051] A conditional disabled variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051)) +- [[tutorial 060] A variable with type "domainname", parameters type and disabled](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_060/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060)) -# [tutorial 060] A variable with type "domainname", parameters type and disabled +# [tutorial 061] A variable with multiple value -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061) ## Screenshot @@ -128,6 +128,7 @@ no_proxy: allow_cidr_network: true allow_without_dot: true allow_startswith_dot: true + multi: true disabled: variable: proxy_mode when: No proxy @@ -181,7 +182,7 @@ This family builds families dynamically. | Variable                                                                                                                                                                                  | Description                                                                                                                                                                               | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` _`disabled`_ | Automatic proxy configuration URL.
**Disabled**: proxy_mode. | -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` _`disabled`_ | Address for which proxy will be desactivated.
**Validators**:
- the domain name can starts by a dot
- the domain name can be a hostname
- the domain name can be an IP
- the domain name can be network in CIDR format
**Disabled**: proxy_mode. | +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` _`disabled`_ `unique` `multiple` | Address for which proxy will be desactivated.
**Validators**:
- the domain name can starts by a dot
- the domain name can be a hostname
- the domain name can be an IP
- the domain name can be network in CIDR format
**Disabled**: proxy_mode. | ## User data @@ -218,7 +219,9 @@ Variables: --- proxy_mode: Automatic proxy configuration URL auto: https://auto.proxy.net/wpad.dat -no_proxy: 192.168.1.0/24 +no_proxy: + - example.net + - 192.168.1.0/24 ``` #### Output @@ -235,8 +238,30 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml Variables: ┣━━ 📓 proxy_mode: Automatic proxy configuration URL (No proxy) ┣━━ 📓 auto: https://auto.proxy.net/wpad.dat -┗━━ 📓 no_proxy: 192.168.1.0/24 +┗━━ 📓 no_proxy : + ┣━━ example.net + ┗━━ 192.168.1.0/24 + +### Example 3 + +#### config/03/config.yaml + + +```yml +--- +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat + +``` +#### Output + +```console +foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml +``` +
🛑 ERRORS
+┣━━ The following variables are mandatory but have no value:
+┗━━   - no_proxy (Address for which proxy will be desactivated)
-- [[tutorial 061] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061)) +- [[tutorial 062] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_062~1..v1.1_062)) diff --git a/config/02/config.yaml b/config/02/config.yaml index 54956ea..ccba4c0 100644 --- a/config/02/config.yaml +++ b/config/02/config.yaml @@ -1,4 +1,6 @@ --- proxy_mode: Automatic proxy configuration URL auto: https://auto.proxy.net/wpad.dat -no_proxy: 192.168.1.0/24 +no_proxy: + - example.net + - 192.168.1.0/24 diff --git a/config/02/output_ro.html b/config/02/output_ro.html index 6f52431..3432302 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -7,5 +7,7 @@ Variables: ┣━━ 📓 proxy_mode: Automatic proxy configuration URL (No proxy) ┣━━ 📓 auto: https://auto.proxy.net/wpad.dat -┗━━ 📓 no_proxy: 192.168.1.0/24 +┗━━ 📓 no_proxy : + ┣━━ example.net + ┗━━ 192.168.1.0/24 diff --git a/config/03/config.yaml b/config/03/config.yaml new file mode 100644 index 0000000..307e175 --- /dev/null +++ b/config/03/config.yaml @@ -0,0 +1,3 @@ +--- +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat diff --git a/config/03/output_ro.html b/config/03/output_ro.html new file mode 100644 index 0000000..91a9675 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,4 @@ +
🛑 ERRORS
+┣━━ The following variables are mandatory but have no value:
+┗━━   - no_proxy (Address for which proxy will be desactivated)
+