diff --git a/CHANGELOG.md b/CHANGELOG.md
index 015a2016..066d94a7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,17 +1,5 @@
-# Modified variables
+# New variable
-| Variable | Description |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **proxy_mode**
`standard` [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
• No proxy **← (default)**
• Auto-detect proxy settings for this network
• Use system proxy settings
• Manual proxy configuration
• Automatic proxy configuration URL |
-| **manual.http_proxy.address**
`basic` [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP proxy address.
**Validators**:
• type domainname
• the domain name can be an IP |
-| **manual.http_proxy.port**
`standard` [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTP proxy port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: 8080 |
-| **manual.use_for_https**
`standard` [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Also use this proxy for HTTPS.
**Default**: true |
-| **manual.https_proxy.address**
`standard` [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTPS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP proxy address](#manual.http_proxy.address)". |
-| **manual.https_proxy.port**
`standard` [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTPS proxy port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: the value of the variable "[HTTP proxy port](#manual.http_proxy.port)". |
-| **manual.socks_proxy.address**
`standard` [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | SOCKS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP proxy address](#manual.http_proxy.address)". |
-| **manual.socks_proxy.port**
`standard` [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | SOCKS proxy port.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• private ports (greater than 49152) are allowed
**Default**: the value of the variable "[HTTP proxy port](#manual.http_proxy.port)". |
-| **manual.socks_proxy.version**
`standard` [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)** |
-| **auto**
`basic` [`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `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**
`standard` [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`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**
`standard` [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `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**
`advanced` [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.
**Default**: false
**Disabled**: if "[Configure Proxy Access to the Internet](#proxy_mode)" is not "Manual proxy configuration"
or "[SOCKS host version used by proxy](#manual.socks_proxy.version)" is "v4". |
+| 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 |
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index b726309d..5241189d 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -58,3 +58,14 @@
| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`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) `standard` `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) `advanced` `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.
**Default**: false
**Disabled**: if "[Configure Proxy Access to the Internet](#proxy_mode)" is not "Manual proxy configuration"
or "[SOCKS host version used by proxy](#manual.socks_proxy.version)" is "v4". |
+
+# DNS over HTTPS
+
+> [!NOTE]
+>
+> **Path**: dns_over_https\
+> `standard`
+
+| 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 |
diff --git a/README.md b/README.md
index 3c1c05c4..d012c54d 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_120] Disabled a variable when an other variable are disabled](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_130~1..v1.1_130))
+- [[tutorial v1.1_130] A variable in avanced mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_130/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_140~1..v1.1_140))
-# [tutorial v1.1_130] A variable in avanced mode
+# [tutorial v1.1_140] A boolean variable
-[Read the tutorial "A variable in avanced mode" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-variable-in-avanced-mode)
+[Read the tutorial "A boolean variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-boolean-variable)
## Screenshot
@@ -25,44 +25,37 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
Then switch to the tutorial page:
```shell
-git switch --detach v1.1_130
+git switch --detach v1.1_140
```
## Structure
-.
- ├── 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
+.
+ ├── 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
+ └── types
+ └── proxy
+ └── 00-type.yml
╭───────────────────── Caption ─────────────────────╮ -│ Variable Default value │ -│ Unmodifiable variable Modified value │ -│ (⏳ Original default value) │ -╰───────────────────────────────────────────────────╯ -Variables: -┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy -┃ configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No -┃ proxy) -┣━━ 📂 manual (Manual proxy configuration) -┃ ┣━━ 📂 http_proxy (HTTP Proxy) -┃ ┃ ┣━━ 📓 address (HTTP proxy address): http.proxy.net ◀ loaded from the -┃ ┃ ┃ YAML file "config/02/config.yml" -┃ ┃ ┗━━ 📓 port (HTTP proxy port): 8080 -┃ ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): true -┃ ┣━━ 📂 https_proxy (HTTPS Proxy) -┃ ┃ ┣━━ 📓 address (HTTPS proxy address): http.proxy.net -┃ ┃ ┗━━ 📓 port (HTTPS proxy port): 8080 -┃ ┗━━ 📂 socks_proxy (SOCKS Proxy) -┃ ┣━━ 📓 address (SOCKS proxy address): http.proxy.net -┃ ┣━━ 📓 port (SOCKS 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 -┗━━ 📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false -diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt deleted file mode 100644 index 88a842ba..00000000 --- a/config/03/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ --types types/proxy --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 deleted file mode 100644 index d04e72ce..00000000 --- a/config/03/config.yml +++ /dev/null @@ -1,6 +0,0 @@ ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net -proxy_dns_socks5: true diff --git a/config/03/output_ro.html b/config/03/output_ro.html deleted file mode 100644 index 8684818e..00000000 --- a/config/03/output_ro.html +++ /dev/null @@ -1,28 +0,0 @@ -
╭───────────────────── Caption ─────────────────────╮ -│ Variable Default value │ -│ Unmodifiable variable Modified value │ -│ (⏳ Original default value) │ -╰───────────────────────────────────────────────────╯ -Variables: -┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy -┃ configuration ◀ loaded from the YAML file "config/03/config.yml" (⏳ No -┃ proxy) -┣━━ 📂 manual (Manual proxy configuration) -┃ ┣━━ 📂 http_proxy (HTTP Proxy) -┃ ┃ ┣━━ 📓 address (HTTP proxy address): http.proxy.net ◀ loaded from the -┃ ┃ ┃ YAML file "config/03/config.yml" -┃ ┃ ┗━━ 📓 port (HTTP proxy port): 8080 -┃ ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): true -┃ ┣━━ 📂 https_proxy (HTTPS Proxy) -┃ ┃ ┣━━ 📓 address (HTTPS proxy address): http.proxy.net -┃ ┃ ┗━━ 📓 port (HTTPS proxy port): 8080 -┃ ┗━━ 📂 socks_proxy (SOCKS Proxy) -┃ ┣━━ 📓 address (SOCKS proxy address): http.proxy.net -┃ ┣━━ 📓 port (SOCKS 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 -┗━━ 📓 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/cmd_ro.txt b/config/04/cmd_ro.txt deleted file mode 100644 index 6219b69f..00000000 --- a/config/04/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ --types types/proxy --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 deleted file mode 100644 index 8ceca7bc..00000000 --- a/config/04/config.yml +++ /dev/null @@ -1,7 +0,0 @@ ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - socks_proxy: - version: v4 diff --git a/config/04/output_ro.html b/config/04/output_ro.html deleted file mode 100644 index eae84caa..00000000 --- a/config/04/output_ro.html +++ /dev/null @@ -1,27 +0,0 @@ -
╭───────────────────── Caption ─────────────────────╮ -│ Variable Default value │ -│ Unmodifiable variable Modified value │ -│ (⏳ Original default value) │ -╰───────────────────────────────────────────────────╯ -Variables: -┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy -┃ configuration ◀ loaded from the YAML file "config/04/config.yml" (⏳ No -┃ proxy) -┣━━ 📂 manual (Manual proxy configuration) -┃ ┣━━ 📂 http_proxy (HTTP Proxy) -┃ ┃ ┣━━ 📓 address (HTTP proxy address): http.proxy.net ◀ loaded from the -┃ ┃ ┃ YAML file "config/04/config.yml" -┃ ┃ ┗━━ 📓 port (HTTP proxy port): 8080 -┃ ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): true -┃ ┣━━ 📂 https_proxy (HTTPS Proxy) -┃ ┃ ┣━━ 📓 address (HTTPS proxy address): http.proxy.net -┃ ┃ ┗━━ 📓 port (HTTPS proxy port): 8080 -┃ ┗━━ 📂 socks_proxy (SOCKS Proxy) -┃ ┣━━ 📓 address (SOCKS proxy address): http.proxy.net -┃ ┣━━ 📓 port (SOCKS proxy port): 8080 -┃ ┗━━ 📓 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 -diff --git a/firefox.png b/firefox.png index 34e6c084..d368003e 100644 Binary files a/firefox.png and b/firefox.png differ diff --git a/tree.html b/tree.html index 44afb48d..ba7d7787 100644 --- a/tree.html +++ b/tree.html @@ -1,14 +1,15 @@
-.
- ├── 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
+.
+ ├── 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
+ └── types
+ └── proxy
+ └── 00-type.yml