diff --git a/README.md b/README.md index ff390683..c4096bf9 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_104] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_104/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110)) +- [[tutorial v1.1_110] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111)) -# [tutorial v1.1_110] A conditional disabled boolean variable +# [tutorial v1.1_111] A boolean variable -[Read the tutorial "A conditional disabled boolean variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-conditional-disabled-boolean-variable) +[Read the tutorial "A boolean variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-boolean-variable) ## 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_110 +git switch --detach v1.1_111 ``` ## Structure @@ -37,32 +37,28 @@ git switch --detach v1.1_110

-.
- ├── 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 ... ``` @@ -130,6 +126,7 @@ rougail -m firefox/ --types types/proxy -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 | *** @@ -140,9 +137,9 @@ rougail -m firefox/ --types types/proxy -o doc --doc.contents changelog --doc.ch ``` #### 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 | *** @@ -171,6 +168,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 @@ -217,6 +215,7 @@ Variables: - :notebook: version (SOCKS host version used by proxy): v5 - :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 @@ -239,10 +238,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:** @@ -268,6 +263,7 @@ Variables: - :notebook: version (SOCKS host version used by proxy): v5 - :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 @@ -316,8 +312,9 @@ Variables: - :notebook: version (SOCKS host version used by proxy): v4 ← loaded from the YAML file "config/04/config.yml" (:hourglass_flowing_sand: v5) - :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 *** -- [[tutorial v1.1_111] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111)) +- [[tutorial v1.1_112] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_112~1..v1.1_112)) 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 241fd481..3027f4ae 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -21,6 +21,7 @@ Variables: ┃ ┣━━ 📓 port (Proxy port): 8080 ┃ ┗━━ 📓 version (SOCKS host version used by proxy): v5 ┣━━ 📓 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 fa2af50c..f3dce878 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) │
@@ -26,6 +21,8 @@ Variables:
 ┃       ┣━━ 📓 port (Proxy port): 8080
 ┃       ┗━━ 📓 version (SOCKS host version used by proxy): v5
 ┣━━ 📓 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 64e6cdb0..4a3b8bab 100644
--- a/config/04/output_ro.html
+++ b/config/04/output_ro.html
@@ -22,6 +22,7 @@ Variables:
 ┃       ┗━━ 📓 version (SOCKS host version used by proxy): v4 ◀ loaded from the 
 ┃           YAML file "config/04/config.yml" (⏳ v5)
 ┣━━ 📓 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 95cc6f03..78e4c978 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