From 1a97db85e5f21c5343622f7669ecdc3814895827 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sat, 18 Apr 2026 21:48:00 +0200 Subject: [PATCH] [tutorial v1.1_101] A variable with multiple value (config and doc) --- CHANGELOG.md | 8 +++--- DOCUMENTATION.md | 8 +++--- README.md | 61 +++++++++++++++++++++++++++++----------- config/02/config.yml | 4 ++- config/02/output_ro.html | 5 ++-- config/03/cmd_ro.txt | 1 + config/03/config.yml | 3 ++ config/03/output_ro.html | 4 +++ tree.html | 20 ++++++------- 9 files changed, 76 insertions(+), 38 deletions(-) create mode 100644 config/03/cmd_ro.txt create mode 100644 config/03/config.yml create mode 100644 config/03/output_ro.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 0ae489b5..4e3071c5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ -# New variable +# Modified variable -| Variable | Description | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Address for which proxy will be desactivated.
**Validators**:
• type domainname
• 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**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy". | +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **no_proxy**
`multiple` [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* `unique` | Address for which proxy will be desactivated.
**Validators**:
• type domainname
• 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**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy". | diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 4a5e2dec..33eb550a 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -50,7 +50,7 @@ | **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS proxy port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: the value of the variable "[HTTP proxy port](#manual.http_proxy.port)". | | **manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)** | -| Variable | Description | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **auto**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL". | -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Address for which proxy will be desactivated.
**Validators**:
• type domainname
• 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**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy". | +| Variable | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **auto**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL". | +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` *`disabled`* `unique` | Address for which proxy will be desactivated.
**Validators**:
• type domainname
• 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**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy". | diff --git a/README.md b/README.md index ea02a73b..a329cf39 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 v1.1_090] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100)) +- [[tutorial v1.1_100] A conditional disabled variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101)) -# [tutorial v1.1_100] A conditional disabled variable with type domainname and parameters +# [tutorial v1.1_101] A variable with multiple value -[Read the tutorial "A conditional disabled variable with type domainname and parameters" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-conditional-disabled-variable-with-type-domainname-and-parameters) +[Read the tutorial "A variable with multiple value" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-variable-with-multiple-value) ## Screenshot @@ -25,22 +25,22 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_100 +git switch --detach v1.1_101 ``` ## Structure

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   └── 40-no_proxy.yml
- └── types
-     └── proxy
-         └── 00-type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   └── 40-no_proxy.yml
+ └── types
+     └── proxy
+         └── 00-type.yml


Contents of the firefox/40-no_proxy.yml file @@ -58,6 +58,7 @@ no_proxy: allow_cidr_network: true allow_without_dot: true allow_startswith_dot: true + multi: true disabled: variable: _.proxy_mode when: No proxy @@ -119,7 +120,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 ``` *** @@ -138,9 +141,33 @@ rougail -m firefox/ --types types/proxy -u yaml -yf config/02/config.yml Variables: - :notebook: proxy_mode (Configure Proxy Access to the Internet): Automatic proxy configuration URL ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: No proxy) - :notebook: auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat ← loaded from the YAML file "config/02/config.yml" -- :notebook: no_proxy (Address for which proxy will be desactivated): 192.168.1.0/24 ← loaded from the YAML file "config/02/config.yml" +- :notebook: no_proxy (Address for which proxy will be desactivated): + - example.net ← loaded from the YAML file "config/02/config.yml" + - 192.168.1.0/24 ← loaded from the YAML file "config/02/config.yml" + +*** +### Example 3 + +#### config/03/config.yml + + +```yml +--- +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat +``` + +*** +#### Output + +```shell +rougail -m firefox/ --types types/proxy -u yaml -yf config/03/config.yml +``` +> [!CAUTION] +> +> - no_proxy (Address for which proxy will be desactivated): :stop_sign: mandatory variable but has no value *** -- [[tutorial v1.1_101] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_101/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101)) +- [[tutorial v1.1_102] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102)) diff --git a/config/02/config.yml b/config/02/config.yml index 54956ea6..ccba4c0f 100644 --- a/config/02/config.yml +++ b/config/02/config.yml @@ -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 02135a2a..4b911fab 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -8,6 +8,7 @@ Variables: ┃ proxy) ┣━━ 📓 auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat ┃ ◀ loaded from the YAML file "config/02/config.yml" -┗━━ 📓 no_proxy (Address for which proxy will be desactivated): 192.168.1.0/24 ◀ - loaded from the YAML file "config/02/config.yml" +┗━━ 📓 no_proxy (Address for which proxy will be desactivated): + ┣━━ example.net ◀ loaded from the YAML file "config/02/config.yml" + ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/02/config.yml" diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt new file mode 100644 index 00000000..3c55adcb --- /dev/null +++ b/config/03/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ --types types/proxy -u yaml -yf config/03/config.yml \ No newline at end of file diff --git a/config/03/config.yml b/config/03/config.yml new file mode 100644 index 00000000..307e175b --- /dev/null +++ b/config/03/config.yml @@ -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 00000000..1d2c49b1 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,4 @@ +
🛑 Caution
+┗━━ no_proxy (Address for which proxy will be desactivated): 🛑 mandatory 
+    variable but has no value
+
diff --git a/tree.html b/tree.html index 69e17d9d..98d1cd9a 100644 --- a/tree.html +++ b/tree.html @@ -1,12 +1,12 @@

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   └── 40-no_proxy.yml
- └── types
-     └── proxy
-         └── 00-type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   └── 40-no_proxy.yml
+ └── types
+     └── proxy
+         └── 00-type.yml


\ No newline at end of file