diff --git a/README.md b/README.md
index fcf86b1f..0e6ea1ca 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_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_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))
-# [tutorial v1.1_102)] A web_address variable
+# [tutorial v1.1_103)] A variable with custom validation
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103)
-[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-web_address-variable)
+[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-custom-validation)
## 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_102
+git switch --detach v1.1_103
```
## Structure
@@ -39,16 +39,16 @@ git switch --detach v1.1_102
-.
- └── 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
@@ -76,6 +76,12 @@ dns_over_https: # DNS over HTTPS
custom_dns_url:
description: Custom DNS URL
type: web_address
+ validators:
+ - jinja: |-
+ {% if _.custom_dns_url.startswith('http://') %}
+ only https is allowed
+ {% endif %}
+ description: must starts with 'https://' only
disabled:
jinja: |-
{% if _.provider is propertyerror or _.provider != 'Custom' %}
@@ -153,18 +159,18 @@ or "firefox.manual.socks_proxy.version" is "v4"
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **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 "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.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: if "_.provider" is not "Custom" |
+| **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**:
- the domain name in web address can be only a hostname
- must starts with 'https://' only
**Disabled**: if "_.provider" is not "Custom" |
### Let's generate the changelog
```shell
rougail -m firefox/ --modes_level basic standard advanced -o doc --doc.contents changelog
```
-#### New variable
+#### Modified variable
| 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.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: if "_.provider" is not "Custom" |
+| **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**:
- the domain name in web address can be only a hostname
- must starts with 'https://' only
**Disabled**: if "_.provider" is not "Custom" |
## User datas
@@ -233,17 +239,12 @@ dns_over_https:
```shell
rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/03/config.yml
```
-╭────────────── Caption ───────────────╮
-│ Variable Default value │
-│ 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"
+🔔 WARNINGS
+┗━━ the value "http://dns.net" is an invalid URL for "dns_over_https.custom_dns_url" (Custom DNS URL), only https is allowed, it will be ignored when loading from the YAML file "config/03/config.yml"
+🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+ ┗━━ DNS over HTTPS
+ ┗━━ Custom DNS URL
### Example 4
@@ -276,4 +277,4 @@ Variables:
-- [[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))
+- [[tutorial v1.1_110] Namespace](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_110~1..v1.1_110))
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index ba1a2df2..f90b6d1e 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -1,12 +1,7 @@
-╭────────────── Caption ───────────────╮
-│ Variable Default value │
-│ 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"
+🔔 WARNINGS
+┗━━ the value "http://dns.net" is an invalid URL for "dns_over_https.custom_dns_url" (Custom DNS URL), only https is allowed, it will be ignored when loading from the YAML file "config/03/config.yml"
+🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+ ┗━━ DNS over HTTPS
+ ┗━━ Custom DNS URL
diff --git a/tree.html b/tree.html
index 8776c3df..b8e0dd3b 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