|
|
|
|
@ -1,9 +1,9 @@
|
|
|
|
|
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
|
|
|
|
- [[tutorial v1.1_082] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_082/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_082~1..v1.1_082))
|
|
|
|
|
- [[tutorial v1.1_083] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_083/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_083~1..v1.1_083))
|
|
|
|
|
|
|
|
|
|
# [tutorial v1.1_083)] A variable with custom validation
|
|
|
|
|
# [tutorial v1.1_100)] Namespace
|
|
|
|
|
|
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_083~1..v1.1_083)
|
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Screenshot
|
|
|
|
|
@ -241,11 +241,21 @@ dns_over_https: # DNS over HTTPS
|
|
|
|
|
description: if "_.provider" is not "Custom"
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
### firefox/empty.yml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
%YAML 1.2
|
|
|
|
|
---
|
|
|
|
|
version: 1.1
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
### Let's generate the documentation
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_083
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_100
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ --modes_level basic standard advanced -o doc
|
|
|
|
|
```
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
@ -313,129 +323,6 @@ or "firefox.manual.socks_proxy.version" is "v4"
|
|
|
|
|
| **dns_over_https.provider**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Use Provider.<br/>**Choices**: <br/>- Cloudflare **← (default)**<br/>- NextDNS<br/>- Custom<br/>**Disabled**: when the variable "dns_over_https.enable_dns_over_https" has the value "false" |
|
|
|
|
|
| **dns_over_https.custom_dns_url**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS URL.<br/>**Validators**: <br/>- the domain name in web address can be only a hostname<br/>- must starts with 'https://' only<br/>**Disabled**: if "_.provider" is not "Custom" |
|
|
|
|
|
|
|
|
|
|
### Let's generate the changelog
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_083
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ --modes_level basic standard advanced -o doc --doc.contents changelog
|
|
|
|
|
```
|
|
|
|
|
#### Modified variable
|
|
|
|
|
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| **dns_over_https.custom_dns_url**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS URL.<br/>**Validators**: <br/>- the domain name in web address can be only a hostname<br/>- <ins>must starts with 'https://' only</ins><br/>**Disabled**: if "_.provider" is not "Custom" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## User datas
|
|
|
|
|
|
|
|
|
|
### Example 1
|
|
|
|
|
|
|
|
|
|
#### config/01/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_083
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ --modes_level basic standard advanced -u yaml -ff config/01/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭─────── Caption ────────╮
|
|
|
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
|
|
|
╰────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📂 DNS over HTTPS
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 Enable DNS over HTTPS: <span style="color: #ffd700">false</span>
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 2
|
|
|
|
|
|
|
|
|
|
#### config/02/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
dns_over_https:
|
|
|
|
|
enable_dns_over_https: true
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_083
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ --modes_level basic standard advanced -u yaml -ff config/02/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭────────────── Caption ───────────────╮
|
|
|
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
|
|
|
│ Modified value │
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📂 DNS over HTTPS
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file "config/02/config.yaml" (⏳ <span style="color: #00aa00">false</span>)
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 Use Provider: <span style="color: #ffd700">Cloudflare</span>
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 3
|
|
|
|
|
|
|
|
|
|
#### config/03/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
dns_over_https:
|
|
|
|
|
enable_dns_over_https: true
|
|
|
|
|
provider: Custom
|
|
|
|
|
custom_dns_url: http://dns.net
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_083
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ --modes_level basic standard advanced -u yaml -ff config/03/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
|
|
|
|
<span style="color: #ffff00">┗━━ </span>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.yaml"
|
|
|
|
|
<span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
|
|
|
|
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>DNS over HTTPS
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Custom DNS URL
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 4
|
|
|
|
|
|
|
|
|
|
#### config/04/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
dns_over_https:
|
|
|
|
|
enable_dns_over_https: true
|
|
|
|
|
provider: Custom
|
|
|
|
|
custom_dns_url: https://dns.net
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_083
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ --modes_level basic standard advanced -u yaml -ff config/04/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭────────────── Caption ───────────────╮
|
|
|
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
|
|
|
│ Modified value │
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📂 DNS over HTTPS
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file "config/04/config.yaml" (⏳ <span style="color: #00aa00">false</span>)
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 Use Provider: Custom ◀ loaded from the YAML file "config/04/config.yaml" (⏳ <span style="color: #00aa00">Cloudflare</span>)
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 Custom DNS URL: https://dns.net ◀ loaded from the YAML file "config/04/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- [[tutorial v1.1_100] Namespace](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] xxx](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))
|
|
|
|
|
|
