diff --git a/README.md b/README.md index 996bb266..ec652931 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_142] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_142/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_150~1..v1.1_150)) +- [[tutorial v1.1_150] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_150/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_160~1..v1.1_160)) -# [tutorial v1.1_150] A variable with custom validation +# [tutorial v1.1_160] Namespace -[Read the tutorial "A variable with custom validation" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-variable-with-custom-validation) +[Read the tutorial "Namespace" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#namespace) ## Screenshot @@ -29,7 +29,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_150 +git switch --detach v1.1_160 ``` ## Structure @@ -37,154 +37,155 @@ git switch --detach v1.1_150

-.
- ├── 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
+.
+ ├── 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


-Contents of the firefox/60-dns_over_https.yml file - -```yml -%YAML 1.2 ---- -version: 1.1 - -dns_over_https: # DNS over HTTPS - - enable_dns_over_https: false # Enable DNS over HTTPS - - provider: - description: Use Provider - choices: - - Cloudflare - - NextDNS - - Custom - default: Cloudflare - disabled: - variable: _.enable_dns_over_https - when: false - - custom_dns_url: - description: Custom DNS URL - type: web_address - validators: - - jinja: |- - {{ _.custom_dns_url.startswith("http://") }} - return_type: boolean - description: must starts with 'https://' only - disabled: - jinja: |- - {{ _.provider is propertyerror or _.provider != 'Custom' }} - return_type: boolean - description: if "_.provider" is not "Custom" -... - -``` - -*** ### Let's generate the documentation ```shell -rougail -m firefox/ --types types/proxy --modes_level basic standard advanced -o doc +rougail -m firefox/ -s Firefox --types types/proxy --modes_level basic standard advanced -o doc ``` -| Variable | Description | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **proxy_mode**
[`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 proxy configuration +#### Firefox > [!NOTE] > -> **Path**: manual\ -> `basic` *`disabled`*\ -> **Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Manual proxy configuration" - -##### HTTP Proxy - -> [!NOTE] -> -> **Path**: manual.http_proxy\ +> This family is a namespace.\ +> **Path**: firefox\ > `basic` -| Variable | Description | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP | -| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | 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 | +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **firefox.proxy_mode**
[`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 | -| Variable | Description | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| -| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Also use this proxy for HTTPS.
**Default**: true | - -##### HTTPS Proxy +##### Manual proxy configuration > [!NOTE] > -> **Path**: manual.https_proxy\ +> **Path**: firefox.manual\ +> `basic` *`disabled`*\ +> **Disabled**: when the variable "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" hasn't the value "Manual proxy configuration" + +###### HTTP Proxy + +> [!NOTE] +> +> **Path**: firefox.manual.http_proxy\ +> `basic` + +| Variable | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **firefox.manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP | +| **firefox.manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | 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 | + +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **firefox.manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Also use this proxy for HTTPS.
**Default**: true | + +###### HTTPS Proxy + +> [!NOTE] +> +> **Path**: firefox.manual.https_proxy\ > `standard` *`hidden`*\ -> **Hidden**: when the variable "[Also use this proxy for HTTPS](#manual.use_for_https)" has the value "true" +> **Hidden**: when the variable "[Also use this proxy for HTTPS](#firefox.manual.use_for_https)" has the value "true" -| Variable | Description | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#manual.http_proxy.address)" | -| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | 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 "[Proxy port](#manual.http_proxy.port)" | +| Variable | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **firefox.manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#firefox.manual.http_proxy.address)" | +| **firefox.manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | 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 "[Proxy port](#firefox.manual.http_proxy.port)" | -##### SOCKS Proxy +###### SOCKS Proxy > [!NOTE] > -> **Path**: manual.socks_proxy\ +> **Path**: firefox.manual.socks_proxy\ > `standard` -| Variable | Description | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#manual.http_proxy.address)" | -| **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | 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 "[Proxy port](#manual.http_proxy.port)" | -| **manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)** | +| Variable | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **firefox.manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#firefox.manual.http_proxy.address)" | +| **firefox.manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | 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 "[Proxy port](#firefox.manual.http_proxy.port)" | +| **firefox.manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)** | -| Variable | Description | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **auto**
[`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**
[`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" | +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **firefox.auto**
[`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](#firefox.proxy_mode)" hasn't the value "Automatic proxy configuration URL" | +| **firefox.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](#firefox.proxy_mode)" has the value "No proxy" | +| **firefox.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](#firefox.proxy_mode)" has the value "No proxy" | +| **firefox.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](#firefox.proxy_mode)" is not "Manual proxy configuration"
or "[SOCKS host version used by proxy](#firefox.manual.socks_proxy.version)" is "v4" | -#### DNS over HTTPS +##### DNS over HTTPS > [!NOTE] > -> **Path**: dns_over_https\ +> **Path**: firefox.dns_over_https\ > `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" | -| **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
• must starts with 'https://' only
**Disabled**: if "[Use Provider](#dns_over_https.provider)" is not "Custom" | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **firefox.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 | +| **firefox.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](#firefox.dns_over_https.enable_dns_over_https)" has the value "false" | +| **firefox.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
• must starts with 'https://' only
**Disabled**: if "[Use Provider](#firefox.dns_over_https.provider)" is not "Custom" | *** ### Let's generate the changelog ```shell -rougail -m firefox/ --types types/proxy --modes_level basic standard advanced -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml +rougail -m firefox/ -s Firefox --types types/proxy --modes_level basic standard advanced -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml ``` -#### Modified variable +#### New variables -| 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
• must starts with 'https://' only
**Disabled**: if "[Use Provider](#dns_over_https.provider)" is not "Custom" | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **firefox.proxy_mode**
[`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 | +| **firefox.manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP | +| **firefox.manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | 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 | +| **firefox.manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Also use this proxy for HTTPS.
**Default**: true | +| **firefox.manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#firefox.manual.http_proxy.address)" | +| **firefox.manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | 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 "[Proxy port](#firefox.manual.http_proxy.port)" | +| **firefox.manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#firefox.manual.http_proxy.address)" | +| **firefox.manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | 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 "[Proxy port](#firefox.manual.http_proxy.port)" | +| **firefox.manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)** | +| **firefox.auto**
[`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](#firefox.proxy_mode)" hasn't the value "Automatic proxy configuration URL" | +| **firefox.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](#firefox.proxy_mode)" has the value "No proxy" | +| **firefox.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](#firefox.proxy_mode)" has the value "No proxy" | +| **firefox.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](#firefox.proxy_mode)" is not "Manual proxy configuration"
or "[SOCKS host version used by proxy](#firefox.manual.socks_proxy.version)" is "v4" | +| **firefox.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 | +| **firefox.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](#firefox.dns_over_https.enable_dns_over_https)" has the value "false" | +| **firefox.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
• must starts with 'https://' only
**Disabled**: if "[Use Provider](#firefox.dns_over_https.provider)" is not "Custom" | + +#### Deleted variables +- proxy_mode +- manual.http_proxy.address +- manual.http_proxy.port +- manual.use_for_https +- manual.https_proxy.address +- manual.https_proxy.port +- manual.socks_proxy.address +- manual.socks_proxy.port +- manual.socks_proxy.version +- auto +- no_proxy +- prompt_authentication +- proxy_dns_socks5 +- dns_over_https.enable_dns_over_https +- dns_over_https.provider +- dns_over_https.custom_dns_url *** ## User datas @@ -195,42 +196,16 @@ rougail -m firefox/ --types types/proxy --modes_level basic standard advanced -o ```yml --- +firefox: + dns_over_https: + enable_dns_over_https: true ``` *** #### Output ```shell -rougail -m firefox/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml -``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value - -Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy -- :open_file_folder: dns_over_https (DNS over HTTPS) - - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false - -*** -### Example 2 - -#### config/02/config.yml - - -```yml ---- -dns_over_https: - enable_dns_over_https: true -``` - -*** -#### Output - -```shell -rougail -m firefox/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/02/config.yml +rougail -m firefox/ -s Firefox --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml ``` > [!NOTE] > @@ -241,74 +216,13 @@ rougail -m firefox/ --types types/proxy --modes_level basic standard advanced -u > - (:hourglass_flowing_sand: Original default value) Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy -- :open_file_folder: dns_over_https (DNS over HTTPS) - - :notebook: enable_dns_over_https (Enable DNS over HTTPS): true ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: false) - - :notebook: provider (Use Provider): Cloudflare - -*** -### Example 3 - -#### config/03/config.yml - - -```yml ---- -dns_over_https: - enable_dns_over_https: true - provider: Custom - custom_dns_url: http://dns.net -``` - -*** -#### Output - -```shell -rougail -m firefox/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/03/config.yml -``` -> [!CAUTION] -> -> - dns_over_https (DNS over HTTPS) -> - custom_dns_url (Custom DNS URL) -> - :bell: the value "http://dns.net" is an invalid URL, must starts with 'https://' only, it will be ignored when loading from the YAML file "config/03/config.yml" -> - :stop_sign: mandatory variable but has no value - -*** -### 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/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/04/config.yml -``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy -- :open_file_folder: dns_over_https (DNS over HTTPS) - - :notebook: enable_dns_over_https (Enable DNS over HTTPS): true ← loaded from the YAML file "config/04/config.yml" (:hourglass_flowing_sand: false) - - :notebook: provider (Use Provider): Custom ← loaded from the YAML file "config/04/config.yml" (:hourglass_flowing_sand: Cloudflare) - - :notebook: custom_dns_url (Custom DNS URL): https://dns.net ← loaded from the YAML file "config/04/config.yml" +- :open_file_folder: firefox (Firefox) + - :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy + - :open_file_folder: dns_over_https (DNS over HTTPS) + - :notebook: enable_dns_over_https (Enable DNS over HTTPS): true ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: false) + - :notebook: provider (Use Provider): Cloudflare *** -- [[tutorial v1.1_160] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_160/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_160~1..v1.1_160)) +- [[tutorial v1.1_161] New "FoxyProxy" namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_161/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_161~1..v1.1_161)) diff --git a/config/01/cmd_ro.txt b/config/01/cmd_ro.txt index 6808122f..33259451 100644 --- a/config/01/cmd_ro.txt +++ b/config/01/cmd_ro.txt @@ -1 +1 @@ -rougail -m firefox/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml \ No newline at end of file +rougail -m firefox/ -s Firefox --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml \ No newline at end of file diff --git a/config/01/config.yml b/config/01/config.yml index ed97d539..ef6a0aff 100644 --- a/config/01/config.yml +++ b/config/01/config.yml @@ -1 +1,4 @@ --- +firefox: + dns_over_https: + enable_dns_over_https: true diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 002821d6..8d802961 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,8 +1,13 @@ -
╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
+
╭────────────── Caption ───────────────╮
+│ Variable Default value               │
+│          Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
 Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
-┗━━ 📂 dns_over_https (DNS over HTTPS)
-    ┗━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): false
+┗━━ 📂 firefox (Firefox)
+    ┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
+    ┗━━ 📂 dns_over_https (DNS over HTTPS)
+        ┣━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): true ◀ loaded from
+        ┃   the YAML file "config/01/config.yml" (⏳ false)
+        ┗━━ 📓 provider (Use Provider): Cloudflare
 

diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt
deleted file mode 100644
index 44796ffd..00000000
--- a/config/02/cmd_ro.txt
+++ /dev/null
@@ -1 +0,0 @@
-rougail -m firefox/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/02/config.yml
\ No newline at end of file
diff --git a/config/02/config.yml b/config/02/config.yml
deleted file mode 100644
index aee4796f..00000000
--- a/config/02/config.yml
+++ /dev/null
@@ -1,3 +0,0 @@
----
-dns_over_https:
-  enable_dns_over_https: true
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
deleted file mode 100644
index de930b83..00000000
--- a/config/02/output_ro.html
+++ /dev/null
@@ -1,12 +0,0 @@
-
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
-┗━━ 📂 dns_over_https (DNS over HTTPS)
-    ┣━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): true ◀ loaded from the
-    ┃   YAML file "config/02/config.yml" (⏳ false)
-    ┗━━ 📓 provider (Use Provider): Cloudflare
-

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 2497fc1f..00000000
--- a/config/03/config.yml
+++ /dev/null
@@ -1,5 +0,0 @@
----
-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
deleted file mode 100644
index 4cdee614..00000000
--- a/config/03/output_ro.html
+++ /dev/null
@@ -1,8 +0,0 @@
-
🛑 Caution
-┗━━ dns_over_https (DNS over HTTPS)
-    ┗━━ custom_dns_url (Custom DNS URL)
-        ┣━━ 🔔 the value "http://dns.net" is an invalid URL, must starts with 
-        ┃   'https://' only, it will be ignored when loading from the YAML file 
-        ┃   "config/03/config.yml"
-        ┗━━ 🛑 mandatory variable but has no value
-

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 7f28b0da..00000000
--- a/config/04/config.yml
+++ /dev/null
@@ -1,5 +0,0 @@
----
-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
deleted file mode 100644
index a9734c5e..00000000
--- a/config/04/output_ro.html
+++ /dev/null
@@ -1,15 +0,0 @@
-
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
-┗━━ 📂 dns_over_https (DNS over HTTPS)
-    ┣━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): true ◀ loaded from the
-    ┃   YAML file "config/04/config.yml" (⏳ false)
-    ┣━━ 📓 provider (Use Provider): Custom ◀ loaded from the YAML file 
-    ┃   "config/04/config.yml" (⏳ Cloudflare)
-    ┗━━ 📓 custom_dns_url (Custom DNS URL): https://dns.net ◀ loaded from the 
-        YAML file "config/04/config.yml"
-

diff --git a/tree.html b/tree.html
index b24d1a0b..5b694392 100644
--- a/tree.html
+++ b/tree.html
@@ -1,15 +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

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

 


\ No newline at end of file