diff --git a/CHANGELOG.md b/CHANGELOG.md index bf11d5db..379e8f56 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ # 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 | diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index c75c317f..bd4f3a06 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -55,3 +55,4 @@ | **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 | diff --git a/README.md b/README.md index bc8686c1..62440ef2 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_121] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_121/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_130~1..v1.1_130)) +- [[Previous tutorial v1.1_130] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_130/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_131~1..v1.1_131)) -# [tutorial v1.1_130] A conditional disabled boolean variable +# [tutorial v1.1_131] A boolean variable -- [Read the tutorial "A conditional disabled boolean variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-conditional-disabled-boolean-variable) -- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_130~1..v1.1_130) +- [Read the tutorial "A boolean variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-boolean-variable) +- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_131~1..v1.1_131) ## Screenshot @@ -26,38 +26,34 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_130 +git switch --detach v1.1_131 ``` ## Structure

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   └── 50-prompt_authentication.yml
- └── types
-     └── proxy
-         └── 00-type.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
+ └── types
+     └── proxy
+         └── 00-type.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 ... ``` @@ -105,6 +101,7 @@ rougail -m firefox/ --types types/proxy -u yaml -yf config/01/config.yml Variables: - :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy +- :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false *** ### Example 2 @@ -149,6 +146,7 @@ Variables: - :notebook: address (SOCKS proxy address): null - :notebook: no_proxy (Address for which proxy will be desactivated): [] - :notebook: prompt_authentication (Prompt for authentication if password is saved): true +- :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false *** ### Example 3 @@ -171,10 +169,6 @@ proxy_dns_socks5: true ```shell rougail -m firefox/ --types types/proxy -u yaml -yf config/03/config.yml ``` -> [!WARNING] -> -> - variable or family "proxy_dns_socks5" does not exist so cannot load "proxy_dns_socks5", it will be ignored when loading from the YAML file "config/03/config.yml" - > [!NOTE] > > **Caption:** @@ -198,6 +192,7 @@ Variables: - :notebook: address (SOCKS proxy address): null - :notebook: no_proxy (Address for which proxy will be desactivated): [] - :notebook: prompt_authentication (Prompt for authentication if password is saved): true +- :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): true ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: false) *** ### Example 4 @@ -250,8 +245,9 @@ Variables: - :notebook: address (SOCKS proxy address): null - :notebook: no_proxy (Address for which proxy will be desactivated): [] - :notebook: prompt_authentication (Prompt for authentication if password is saved): true +- :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false *** -- [[Next tutorial v1.1_131] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_131/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_131~1..v1.1_131)) +- [[Next tutorial v1.1_132] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_132/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_132~1..v1.1_132)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index bb585a60..24c5c570 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -2,5 +2,6 @@ │ Variable Default value │ ╰────────────────────────╯ Variables: -┗━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy +┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy +┗━━ 📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false diff --git a/config/02/output_ro.html b/config/02/output_ro.html index a2c6928a..22e7747f 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -19,6 +19,7 @@ Variables: ┃ ┗━━ 📂 socks_proxy (SOCKS Proxy) ┃ ┗━━ 📓 address (SOCKS proxy address): null ┣━━ 📓 no_proxy (Address for which proxy will be desactivated): [] -┗━━ 📓 prompt_authentication (Prompt for authentication if password is saved): - true +┣━━ 📓 prompt_authentication (Prompt for authentication if password is saved): +┃ true +┗━━ 📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false diff --git a/config/03/output_ro.html b/config/03/output_ro.html index de3f1066..5ece3f9b 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,9 +1,4 @@ -
🔔 Warning
-┗━━ variable or family "proxy_dns_socks5" does not exist so cannot load 
-    "proxy_dns_socks5", it will be ignored when loading from the YAML file 
-    "config/03/config.yml"
-
-╭───────────────────── Caption ─────────────────────╮
+
╭───────────────────── Caption ─────────────────────╮
 │ Variable              Default value               │
 │ Unmodifiable variable Modified value              │
 │                       (⏳ Original default value) │
@@ -24,6 +19,8 @@ Variables:
 ┃   ┗━━ 📂 socks_proxy (SOCKS Proxy)
 ┃       ┗━━ 📓 address (SOCKS proxy address): null
 ┣━━ 📓 no_proxy (Address for which proxy will be desactivated): []
-┗━━ 📓 prompt_authentication (Prompt for authentication if password is saved): 
-    true
+┣━━ 📓 prompt_authentication (Prompt for authentication if password is saved): 
+┃   true
+┗━━ 📓 proxy_dns_socks5 (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 61682fce..23b42592 100644
--- a/config/04/output_ro.html
+++ b/config/04/output_ro.html
@@ -26,6 +26,7 @@ Variables:
 ┃   ┗━━ 📂 socks_proxy (SOCKS Proxy)
 ┃       ┗━━ 📓 address (SOCKS proxy address): null
 ┣━━ 📓 no_proxy (Address for which proxy will be desactivated): []
-┗━━ 📓 prompt_authentication (Prompt for authentication if password is saved): 
-    true
+┣━━ 📓 prompt_authentication (Prompt for authentication if password is saved): 
+┃   true
+┗━━ 📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false
diff --git a/tree.html b/tree.html index 20fb91d1..53d16687 100644 --- a/tree.html +++ b/tree.html @@ -1,13 +1,14 @@

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   └── 50-prompt_authentication.yml
- └── types
-     └── proxy
-         └── 00-type.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
+ └── types
+     └── proxy
+         └── 00-type.yml


\ No newline at end of file