From d5287cbb6be88ebe9b285157854fb77d5214b434 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 2 Dec 2025 16:19:07 +0100 Subject: [PATCH] [tutorial v1.1_096] A boolean variable (config and doc) --- README.md | 63 ++++++++++++++++++++-------------------- config/01/output_ro.html | 3 +- config/02/output_ro.html | 3 +- config/03/output_ro.html | 9 +++--- config/04/output_ro.html | 3 +- tree.html | 19 ++++++------ 6 files changed, 51 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 33923be3..d0b65ccd 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_094] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_094/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094)) +- [[tutorial v1.1_095] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095)) -# [tutorial v1.1_095] A conditional disabled boolean variable +# [tutorial v1.1_096] A boolean variable -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-boolean-variable) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable) ## Screenshot @@ -31,7 +31,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_095 +git switch --detach v1.1_096 ``` ## Structure @@ -39,29 +39,25 @@ git switch --detach v1.1_095

-.
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     ├── 20-manual.yml
-     ├── 30-auto.yml
-     ├── 40-no_proxy.yml
-     └── 50-prompt_authentication.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     ├── 10-manual.yml
+     ├── 20-manual.yml
+     ├── 30-auto.yml
+     ├── 40-no_proxy.yml
+     ├── 50-prompt_authentication.yml
+     └── 55-proxy_dns_socks5.yml


-Contents of the firefox/50-prompt_authentication.yml file +Contents of the firefox/55-proxy_dns_socks5.yml file ```yml %YAML 1.2 --- version: 1.1 -prompt_authentication: - description: Prompt for authentication if password is saved - default: true - disabled: - variable: _.proxy_mode - when: No proxy +proxy_dns_socks5: false # Use proxy DNS when using SOCKS v5 ... ``` @@ -122,6 +118,7 @@ rougail -m firefox/ -o doc | **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.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**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
**Examples**:
• .mozilla.org
• .net.nz
• 192.168.1.0/24
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | | **prompt_authentication**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.
**Default**: true
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | +| **proxy_dns_socks5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.
**Default**: false | ### Let's generate the changelog @@ -130,9 +127,9 @@ rougail -m firefox/ -o doc --doc.contents changelog ``` #### New variable -| Variable | Description | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **prompt_authentication**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.
**Default**: true
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | +| Variable | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------| +| **proxy_dns_socks5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.
**Default**: false | ## User datas @@ -154,7 +151,8 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml │ Undocumented but modified variable Default value │ ╰──────────────────────────────────────────────────╯ Variables: -┗━━ 📓 Configure Proxy Access to the Internet: No proxy +┣━━ 📓 Configure Proxy Access to the Internet: No proxy +┗━━ 📓 Use proxy DNS when using SOCKS v5: false ### Example 2 @@ -192,7 +190,8 @@ Variables: ┃ ┣━━ 📓 SOCKS port: 8080 ┃ ┗━━ 📓 SOCKS host version used by proxy: v5 ┣━━ 📓 Address for which proxy will be desactivated: -┗━━ 📓 Prompt for authentication if password is saved: true +┣━━ 📓 Prompt for authentication if password is saved: true +┗━━ 📓 Use proxy DNS when using SOCKS v5: false ### Example 3 @@ -212,10 +211,7 @@ proxy_dns_socks5: true ```shell rougail -m firefox/ -u yaml -yf config/03/config.yml ``` -
🔔 WARNINGS
-┗━━ variable or family "proxy_dns_socks5" does not exist, it will be ignored 
-    when loading from the YAML file "config/03/config.yml"
-╭─────────────────────────── Caption ────────────────────────────╮
+
╭─────────────────────────── Caption ────────────────────────────╮
 │ Variable                           Default value               │
 │ Undocumented but modified variable Modified value              │
 │                                    (⏳ Original default value) │
@@ -234,7 +230,9 @@ Variables:
 ┃       ┣━━ 📓 SOCKS port: 8080
 ┃       ┗━━ 📓 SOCKS host version used by proxy: v5
 ┣━━ 📓 Address for which proxy will be desactivated: 
-┗━━ 📓 Prompt for authentication if password is saved: true
+┣━━ 📓 Prompt for authentication if password is saved: true
+┗━━ 📓 Use proxy DNS when using SOCKS v5: true ◀ loaded from the YAML file 
+    "config/03/config.yml" (⏳ false)
 

 ### Example 4
 
@@ -275,8 +273,9 @@ Variables:
 ┃       ┗━━ 📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file 
 ┃           "config/04/config.yml" (⏳ v5)
 ┣━━ 📓 Address for which proxy will be desactivated: 
-┗━━ 📓 Prompt for authentication if password is saved: true
+┣━━ 📓 Prompt for authentication if password is saved: true
+┗━━ 📓 Use proxy DNS when using SOCKS v5: false
-- [[tutorial v1.1_096] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096)) +- [[tutorial v1.1_097] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_097/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_097~1..v1.1_097)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 14a4529d..6bb9e248 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -2,5 +2,6 @@ │ Undocumented but modified variable Default value │ ╰──────────────────────────────────────────────────╯ Variables: -┗━━ 📓 Configure Proxy Access to the Internet: No proxy +┣━━ 📓 Configure Proxy Access to the Internet: No proxy +┗━━ 📓 Use proxy DNS when using SOCKS v5: false diff --git a/config/02/output_ro.html b/config/02/output_ro.html index c32818ac..3197f3cf 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -17,5 +17,6 @@ Variables: ┃ ┣━━ 📓 SOCKS port: 8080 ┃ ┗━━ 📓 SOCKS host version used by proxy: v5 ┣━━ 📓 Address for which proxy will be desactivated: -┗━━ 📓 Prompt for authentication if password is saved: true +┣━━ 📓 Prompt for authentication if password is saved: true +┗━━ 📓 Use proxy DNS when using SOCKS v5: false diff --git a/config/03/output_ro.html b/config/03/output_ro.html index 14742562..2383c6cc 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,7 +1,4 @@ -
🔔 WARNINGS
-┗━━ variable or family "proxy_dns_socks5" does not exist, it will be ignored 
-    when loading from the YAML file "config/03/config.yml"
-╭─────────────────────────── Caption ────────────────────────────╮
+
╭─────────────────────────── Caption ────────────────────────────╮
 │ Variable                           Default value               │
 │ Undocumented but modified variable Modified value              │
 │                                    (⏳ Original default value) │
@@ -20,5 +17,7 @@ Variables:
 ┃       ┣━━ 📓 SOCKS port: 8080
 ┃       ┗━━ 📓 SOCKS host version used by proxy: v5
 ┣━━ 📓 Address for which proxy will be desactivated: 
-┗━━ 📓 Prompt for authentication if password is saved: true
+┣━━ 📓 Prompt for authentication if password is saved: true
+┗━━ 📓 Use proxy DNS when using SOCKS v5: true ◀ loaded from the YAML file 
+    "config/03/config.yml" (⏳ false)
 

diff --git a/config/04/output_ro.html b/config/04/output_ro.html
index e9fc1484..718757f4 100644
--- a/config/04/output_ro.html
+++ b/config/04/output_ro.html
@@ -18,5 +18,6 @@ Variables:
 ┃       ┗━━ 📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file 
 ┃           "config/04/config.yml" (⏳ v5)
 ┣━━ 📓 Address for which proxy will be desactivated: 
-┗━━ 📓 Prompt for authentication if password is saved: true
+┣━━ 📓 Prompt for authentication if password is saved: true
+┗━━ 📓 Use proxy DNS when using SOCKS v5: false
diff --git a/tree.html b/tree.html index 46fb8cbc..9f455ae1 100644 --- a/tree.html +++ b/tree.html @@ -25,17 +25,18 @@

Directory Tree

- .
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     ├── 20-manual.yml
-     ├── 30-auto.yml
-     ├── 40-no_proxy.yml
-     └── 50-prompt_authentication.yml
+ .
+ └── firefox
+     ├── 00-proxy.yml
+     ├── 10-manual.yml
+     ├── 20-manual.yml
+     ├── 30-auto.yml
+     ├── 40-no_proxy.yml
+     ├── 50-prompt_authentication.yml
+     └── 55-proxy_dns_socks5.yml


-2 directories, 6 files +2 directories, 7 files