From ec57335a02d3a70c00928063a6a6e445bb7c44ce Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sun, 9 Nov 2025 18:57:56 +0100 Subject: [PATCH] [tutorial v1.1_076)] A variable (config and doc) --- README.md | 47 ++++++++++++++++++---------------------- config/03/output_ro.html | 4 +--- tree.html | 19 ++++++++-------- 3 files changed, 32 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index a3ee803c..9a6b50f2 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_074] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_074/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_074~1..v1.1_074)) +- [[tutorial v1.1_075] A variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_075/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_075~1..v1.1_075)) -# [tutorial v1.1_075)] A variable +# [tutorial v1.1_076)] A variable -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_075~1..v1.1_075) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_076~1..v1.1_076) ## Screenshot @@ -29,7 +29,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_075 +git switch --detach v1.1_076 ``` ## Structure @@ -37,29 +37,25 @@ git switch --detach v1.1_075

-.
- └── 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 @@ This family builds families dynamically | **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname | | **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 @@ -189,9 +186,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"
-🛑 ERRORS
+
🛑 ERRORS
 ┗━━ The following variables are mandatory but have no value:
     ┗━━ Automatic proxy configuration URL
 

@@ -220,4 +215,4 @@ rougail -m firefox/ -u yaml -yf config/04/config.yml
-- [[tutorial v1.1_076] A variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_076/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_076~1..v1.1_076)) +- [[tutorial v1.1_077] Jinja calculation for an hidden variable with a potential inaccessible varible](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_077/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_077~1..v1.1_077)) diff --git a/config/03/output_ro.html b/config/03/output_ro.html index 1e18d070..e1ebfb1d 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"
-🛑 ERRORS
+
🛑 ERRORS
 ┗━━ The following variables are mandatory but have no value:
     ┗━━ Automatic proxy configuration URL
 

diff --git a/tree.html b/tree.html
index f951518b..233f6e25 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