diff --git a/README.md b/README.md index c489ea9..71efbb8 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_094] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_094/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094)) +- [[tutorial v1.1_095] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095)) -# [tutorial v1.1_095] A conditional disabled boolean variable +# [tutorial v1.1_096] A boolean variable -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096) -[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_095 +git switch --detach v1.1_096 ``` ## Structure @@ -39,29 +39,25 @@ git switch --detach v1.1_095

-.
- └── 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 ... ``` @@ -122,6 +118,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.
**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 | ### Let's generate the changelog @@ -130,9 +127,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 "[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 | ## User datas @@ -158,6 +155,7 @@ rougail -m firefox/ -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 #### config/02/config.yml @@ -196,6 +194,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 #### config/03/config.yml @@ -214,10 +213,6 @@ proxy_dns_socks5: true ```shell rougail -m firefox/ -u yaml -yf config/03/config.yml ``` -> [!WARNING] -> -> - variable or family "proxy_dns_socks5" does not exist, it will be ignored when loading from the YAML file "config/03/config.yml" - > [!NOTE] > > **Caption:** @@ -239,6 +234,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 #### config/04/config.yml @@ -279,6 +275,7 @@ 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_096] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096)) +- [[tutorial v1.1_097] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_097/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_097~1..v1.1_097)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index bb585a6..24c5c57 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 6c879e1..4a34f7b 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -18,6 +18,7 @@ Variables: ┃ ┣━━ 📓 port (SOCKS 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 b4566c7..1f21083 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,8 +1,4 @@ -
🔔 Warning
-┗━━ 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) │
@@ -22,6 +18,8 @@ Variables:
 ┃       ┣━━ 📓 port (SOCKS 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 7ec8110..5b8bc5f 100644
--- a/config/04/output_ro.html
+++ b/config/04/output_ro.html
@@ -19,6 +19,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 f47197f..5f5a05d 100644 --- a/tree.html +++ b/tree.html @@ -1,10 +1,11 @@

-.
- └── 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


\ No newline at end of file