From 9e64c7d836ec5e3a44fcfbfe22dd1eda75ab02db Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 5 May 2026 06:53:46 +0200 Subject: [PATCH] [tutorial v1.1_111] A variable with multiple values (config and doc) --- CHANGELOG.md | 8 ++--- DOCUMENTATION.md | 8 ++--- README.md | 72 ++++++++++++++++++++++++++++++---------- 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 | 13 ++++++++ tree.html | 20 +++++------ 9 files changed, 95 insertions(+), 39 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 478947a5..d99b4e5f 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) *`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) *`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 8eccd084..bd3e9063 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` *`disabled`* | 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**: 1080
**Disabled**: when the variable "[SOCKS proxy address](#manual.socks_proxy.address)" has the value "null". | | **manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)**
**Disabled**: when the variable "[SOCKS proxy address](#manual.socks_proxy.address)" has the value "null". | -| 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) *`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` *`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 b8a6cea6..a658350a 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ - [List of all the tutorial steps](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[Previous tutorial v1.1_100] A conditional disabled variable with type web_address](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_110~1..v1.1_110)) +- [[Previous tutorial v1.1_110] A conditional disabled non mandatory variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111)) -# [tutorial v1.1_110] A conditional disabled non mandatory variable with type domainname and parameters +# [tutorial v1.1_111] A variable with multiple values -- [Read the tutorial "A conditional disabled non mandatory variable with type domainname and parameters" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-conditional-disabled-non-mandatory-variable-with-type-domainname-and-parameters) -- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110) +- [Read the tutorial "A variable with multiple values" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-variable-with-multiple-values) +- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111) ## Screenshot @@ -26,22 +26,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_110 +git switch --detach v1.1_111 ``` ## 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 @@ -59,6 +59,7 @@ no_proxy: allow_cidr_network: true allow_without_dot: true allow_startswith_dot: true + multi: true mandatory: false disabled: variable: _.proxy_mode @@ -121,7 +122,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 ``` *** @@ -140,9 +143,42 @@ 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 +``` +> [!NOTE] +> +> **Caption:** +> - Variable +> - Default value +> - Modified value +> - (:hourglass_flowing_sand: Original default value) + +Variables: +- :notebook: proxy_mode (Configure Proxy Access to the Internet): Automatic proxy configuration URL ← loaded from the YAML file "config/03/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/03/config.yml" +- :notebook: no_proxy (Address for which proxy will be desactivated): [] *** -- [[Next tutorial v1.1_111] A variable with multiple values](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111)) +- [[Next tutorial v1.1_120] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_120~1..v1.1_120)) 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..2733e947 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,13 @@ +
╭────────────── Caption ───────────────╮
+│ Variable Default value               │
+│          Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Automatic proxy 
+┃   configuration URL ◀ loaded from the YAML file "config/03/config.yml" (⏳ No 
+┃   proxy)
+┣━━ 📓 auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat
+┃   ◀ loaded from the YAML file "config/03/config.yml"
+┗━━ 📓 no_proxy (Address for which proxy will be desactivated): []
+
diff --git a/tree.html b/tree.html index 11b8904d..07013ce2 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