From eed80ef7a81b36c0e72e9b71ac08ae2db5e93a0e Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Tue, 2 Dec 2025 16:19:17 +0100 Subject: [PATCH] [tutorial v1.1_102] A web_address variable (config and doc) --- README.md | 123 +++++++++++++++++++++++++++++++-------- config/03/cmd_ro.txt | 1 + config/03/config.yml | 5 ++ config/03/output_ro.html | 15 +++++ config/04/cmd_ro.txt | 1 + config/04/config.yml | 5 ++ config/04/output_ro.html | 15 +++++ tree.html | 20 +++---- 8 files changed, 151 insertions(+), 34 deletions(-) create mode 100644 config/03/cmd_ro.txt create mode 100644 config/03/config.yml create mode 100644 config/03/output_ro.html create mode 100644 config/04/cmd_ro.txt create mode 100644 config/04/config.yml create mode 100644 config/04/output_ro.html diff --git a/README.md b/README.md index a9bb2249..895068f6 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_100] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100)) +- [[tutorial v1.1_101] A choice variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_101/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101)) -# [tutorial v1.1_101] A choice variable +# [tutorial v1.1_102] A web_address variable -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-choice-variable) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-web_address-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_101 +git switch --detach v1.1_102 ``` ## Structure @@ -39,16 +39,16 @@ git switch --detach v1.1_101

-.
- └── 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
-     └── 60-dns_over_https.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
+     └── 60-dns_over_https.yml


Contents of the firefox/60-dns_over_https.yml file @@ -72,6 +72,16 @@ dns_over_https: # DNS over HTTPS disabled: variable: _.enable_dns_over_https when: false + + custom_dns_url: + description: Custom DNS URL + type: web_address + disabled: + jinja: |- + {% if _.provider is propertyerror or _.provider != 'Custom' %} + provider is not custom + {% endif %} + description: if "_.provider" is not "Custom" ... ``` @@ -140,12 +150,13 @@ rougail -m firefox/ --modes_level basic standard advanced -o doc > **🛈 Informations** > > **Path**: dns_over_https\ -> `standard` +> `basic` -| Variable | Description | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dns_over_https.enable_dns_over_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.
**Default**: false | -| **dns_over_https.provider**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Use Provider.
**Choices**:
• Cloudflare **← (default)**
• NextDNS
• Custom
**Disabled**: when the variable "[Enable DNS over HTTPS](#dns_over_https.enable_dns_over_https)" has the value "false" | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dns_over_https.enable_dns_over_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.
**Default**: false | +| **dns_over_https.provider**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Use Provider.
**Choices**:
• Cloudflare **← (default)**
• NextDNS
• Custom
**Disabled**: when the variable "[Enable DNS over HTTPS](#dns_over_https.enable_dns_over_https)" has the value "false" | +| **dns_over_https.custom_dns_url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS 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**: if "[Use Provider](#dns_over_https.provider)" is not "Custom" | ### Let's generate the changelog @@ -154,9 +165,9 @@ rougail -m firefox/ --modes_level basic standard advanced -o doc --doc.contents ``` #### New variable -| Variable | Description | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **dns_over_https.provider**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Use Provider.
**Choices**:
• Cloudflare **← (default)**
• NextDNS
• Custom
**Disabled**: when the variable "[Enable DNS over HTTPS](#dns_over_https.enable_dns_over_https)" has the value "false" | +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **dns_over_https.custom_dns_url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS 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**: if "[Use Provider](#dns_over_https.provider)" is not "Custom" | ## User datas @@ -210,6 +221,70 @@ Variables: ┃ "config/02/config.yml" (⏳ false) ┗━━ 📓 Use Provider: Cloudflare +### Example 3 + +#### config/03/config.yml -- [[tutorial v1.1_102] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102)) +```yml +--- +dns_over_https: + enable_dns_over_https: true + provider: Custom + custom_dns_url: http://dns.net +``` +#### Output + +```shell +rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/03/config.yml +``` +
╭─────────────────────────── Caption ────────────────────────────╮
+│ Undocumented variable              Default value               │
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 DNS over HTTPS
+    ┣━━ 📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file 
+    ┃   "config/03/config.yml" (⏳ false)
+    ┣━━ 📓 Use Provider: Custom ◀ loaded from the YAML file 
+    ┃   "config/03/config.yml" (⏳ Cloudflare)
+    ┗━━ 📓 Custom DNS URL: http://dns.net ◀ loaded from the YAML file 
+        "config/03/config.yml"
+
+### Example 4 + +#### config/04/config.yml + + +```yml +--- +dns_over_https: + enable_dns_over_https: true + provider: Custom + custom_dns_url: https://dns.net +``` +#### Output + +```shell +rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/04/config.yml +``` +
╭─────────────────────────── Caption ────────────────────────────╮
+│ Undocumented variable              Default value               │
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 DNS over HTTPS
+    ┣━━ 📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file 
+    ┃   "config/04/config.yml" (⏳ false)
+    ┣━━ 📓 Use Provider: Custom ◀ loaded from the YAML file 
+    ┃   "config/04/config.yml" (⏳ Cloudflare)
+    ┗━━ 📓 Custom DNS URL: https://dns.net ◀ loaded from the YAML file 
+        "config/04/config.yml"
+
+ + +- [[tutorial v1.1_103] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103)) diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt new file mode 100644 index 00000000..0c8e9046 --- /dev/null +++ b/config/03/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/03/config.yml \ No newline at end of file diff --git a/config/03/config.yml b/config/03/config.yml new file mode 100644 index 00000000..2497fc1f --- /dev/null +++ b/config/03/config.yml @@ -0,0 +1,5 @@ +--- +dns_over_https: + enable_dns_over_https: true + provider: Custom + custom_dns_url: http://dns.net diff --git a/config/03/output_ro.html b/config/03/output_ro.html new file mode 100644 index 00000000..1fe561a7 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,15 @@ +
╭─────────────────────────── Caption ────────────────────────────╮
+│ Undocumented variable              Default value               │
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 DNS over HTTPS
+    ┣━━ 📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file 
+    ┃   "config/03/config.yml" (⏳ false)
+    ┣━━ 📓 Use Provider: Custom ◀ loaded from the YAML file 
+    ┃   "config/03/config.yml" (⏳ Cloudflare)
+    ┗━━ 📓 Custom DNS URL: http://dns.net ◀ loaded from the YAML file 
+        "config/03/config.yml"
+
diff --git a/config/04/cmd_ro.txt b/config/04/cmd_ro.txt new file mode 100644 index 00000000..84818e51 --- /dev/null +++ b/config/04/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/04/config.yml \ No newline at end of file diff --git a/config/04/config.yml b/config/04/config.yml new file mode 100644 index 00000000..7f28b0da --- /dev/null +++ b/config/04/config.yml @@ -0,0 +1,5 @@ +--- +dns_over_https: + enable_dns_over_https: true + provider: Custom + custom_dns_url: https://dns.net diff --git a/config/04/output_ro.html b/config/04/output_ro.html new file mode 100644 index 00000000..d20cb00c --- /dev/null +++ b/config/04/output_ro.html @@ -0,0 +1,15 @@ +
╭─────────────────────────── Caption ────────────────────────────╮
+│ Undocumented variable              Default value               │
+│ Undocumented but modified variable Modified value              │
+│                                    (⏳ Original default value) │
+╰────────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: No proxy
+┗━━ 📂 DNS over HTTPS
+    ┣━━ 📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file 
+    ┃   "config/04/config.yml" (⏳ false)
+    ┣━━ 📓 Use Provider: Custom ◀ loaded from the YAML file 
+    ┃   "config/04/config.yml" (⏳ Cloudflare)
+    ┗━━ 📓 Custom DNS URL: https://dns.net ◀ loaded from the YAML file 
+        "config/04/config.yml"
+
diff --git a/tree.html b/tree.html index 7b3f9850..8776c3df 100644 --- a/tree.html +++ b/tree.html @@ -25,16 +25,16 @@

Directory Tree

- .
- └── 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
-     └── 60-dns_over_https.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
+     └── 60-dns_over_https.yml


2 directories, 8 files