diff --git a/README.md b/README.md index 94891fe8..d74de143 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_064] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_064/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_064~1..v1.1_064)) +- [[tutorial v1.1_065] A variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_065/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_065~1..v1.1_065)) -# [tutorial v1.1_065)] A variable +# [tutorial v1.1_066)] A variable -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_065~1..v1.1_065) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_066~1..v1.1_066) ## Screenshot @@ -175,11 +175,23 @@ prompt_authentication: when: No proxy ... +``` +### firefox/55-proxy_dns_socks5.yml + + +```yml +%YAML 1.2 +--- +version: 1.1 + +proxy_dns_socks5: false # Use proxy DNS when using SOCKS v5 +... + ``` ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_065 +foo@bar:~$ git switch --detach v1.1_066 foo@bar:~$ rougail -m firefox/ -o doc -do github ``` | Variable                                                                                        | Description                                                                                     | @@ -232,18 +244,19 @@ This family builds families dynamically | **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 ```console -foo@bar:~$ git switch --detach v1.1_065 +foo@bar:~$ git switch --detach v1.1_066 foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github ``` #### 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 @@ -260,14 +273,15 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github #### Output ```console -foo@bar:~$ git switch --detach v1.1_065 +foo@bar:~$ git switch --detach v1.1_066 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml ``` 
╭─────── Caption ────────╮
 │ 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 @@ -285,7 +299,7 @@ manual: #### Output ```console -foo@bar:~$ git switch --detach v1.1_065 +foo@bar:~$ git switch --detach v1.1_066 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml ``` 
╭────────────── Caption ───────────────╮
@@ -305,7 +319,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 @@ -324,12 +339,10 @@ proxy_dns_socks5: true #### Output ```console -foo@bar:~$ git switch --detach v1.1_065 +foo@bar:~$ git switch --detach v1.1_066 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml ``` -
🔔 WARNINGS
-┗━━ variable or family "proxy_dns_socks5" does not exist, it will be ignored when loading from the YAML file "config/03/config.yaml"
-╭────────────── Caption ───────────────╮
+
╭────────────── Caption ───────────────╮
 │ Variable Default value               │
 │          Modified value              │
 │          (⏳ Original default value) │
@@ -346,7 +359,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.yaml" (⏳ false)
 

 ### Example 4
 
@@ -366,7 +380,7 @@ manual:
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_065
+foo@bar:~$ git switch --detach v1.1_066
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
 ```
 
╭────────────── Caption ───────────────╮
@@ -386,8 +400,9 @@ Variables:
 ┃       ┣━━ 📓 SOCKS port: 8080
 ┃       ┗━━ 📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ 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_066] A variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_066/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_066~1..v1.1_066))
+- [[tutorial v1.1_067] Jinja calculation for an hidden variable with a potential inaccessible varible](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_067/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_067~1..v1.1_067))
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 c0707f32..4c904bb0 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 e041954c..e22c6565 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.yaml"
-╭────────────── 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.yaml" (⏳ false)
 

diff --git a/config/04/output_ro.html b/config/04/output_ro.html
index cb68c0ff..242db320 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.yaml" (⏳ 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