From f401977ae7c8b84bff741adf48bbd0fc140990c3 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Mon, 10 Nov 2025 08:21:41 +0100 Subject: [PATCH] [tutorial v1.1_086)] A boolean variable (config and doc) --- README.md | 61 ++++++++++++++++++++-------------------- config/01/output_ro.html | 3 +- config/02/output_ro.html | 3 +- config/03/output_ro.html | 7 ++--- config/04/output_ro.html | 3 +- tree.html | 19 +++++++------ 6 files changed, 49 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 47b3567e..91a52b74 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_084] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_084/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_084~1..v1.1_084)) +- [[tutorial v1.1_085] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_085/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_085~1..v1.1_085)) -# [tutorial v1.1_085)] A conditional disabled boolean variable +# [tutorial v1.1_086)] A boolean variable -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_085~1..v1.1_085) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_086~1..v1.1_086) -[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_085 +git switch --detach v1.1_086 ``` ## Structure @@ -39,29 +39,25 @@ git switch --detach v1.1_085

-.
- └── 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 ... ``` @@ -118,6 +114,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.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL" | | **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**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
**Examples**:
- .mozilla.org
- .net.nz
- 192.168.1.0/24
**Disabled**: when the variable "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 "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 @@ -126,9 +123,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 "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 @@ -150,7 +147,8 @@ rougail -m firefox/ -u yaml -yf config/01/config.yml │ 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 @@ -186,7 +184,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 @@ -206,9 +205,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               │
 │          Modified value              │
 │          (⏳ Original default value) │
@@ -225,7 +222,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: true ◀ loaded from the YAML file "config/03/config.yml" (⏳ false)
 

 ### Example 4
 
@@ -263,8 +261,9 @@ Variables:
 ┃       ┣━━ 📓 SOCKS port: 8080
 ┃       ┗━━ 📓 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_086] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_086/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_086~1..v1.1_086)) +- [[tutorial v1.1_087] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_087/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_087~1..v1.1_087)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index ea9c2266..450d0a74 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -2,5 +2,6 @@ │ 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 d8eb35d9..47357d58 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -15,5 +15,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 cb3ddbe9..4910cdca 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,6 +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               │
 │          Modified value              │
 │          (⏳ Original default value) │
@@ -17,5 +15,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: 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 ad69d5e7..a4e085c3 100644
--- a/config/04/output_ro.html
+++ b/config/04/output_ro.html
@@ -15,5 +15,6 @@ Variables:
 ┃       ┣━━ 📓 SOCKS port: 8080
 ┃       ┗━━ 📓 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 4a9197ba..284e151c 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