diff --git a/README.md b/README.md index b609b61..c12fcc9 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 091] Variable in parent family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_091/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091)) +- [[tutorial 092] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_092/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_092~1..v1.1_092)) -# [tutorial 092] Namespace +# [tutorial 100] xxx -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_092~1..v1.1_092) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100) ## Screenshot @@ -216,23 +216,30 @@ dns_over_https: # DNS over HTTPS ```yml +``` +### foxyproxy/00-foxyproxy.yml + + +```yml +--- + ``` ### Generated documentation ```console -foo@bar:~$ rougail -v 1.1 -m firefox/ --modes_level basic standard advanced -o doc -do github +foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc -do github ``` -### Variables +### Variables for "firefox" | 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 | +| **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 | #### Manual proxy configuration `basic` _`disabled`_ -**Disabled**: when the variable "proxy_mode" hasn't the value "Manual proxy configuration". +**Disabled**: when the variable "firefox.proxy_mode" hasn't the value "Manual proxy configuration". ##### HTTP Proxy @@ -240,12 +247,12 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ --modes_level basic standard advanced -o d | Variable                                                                                                                  | Description                                                                                                               | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP address.
**Validator**: the domain name can be an IP | -| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTP Port.
**Default**: 8080 | +| **firefox.manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP address.
**Validator**: 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` | HTTP Port.
**Default**: 8080 | | 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 | +| **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" or "*SOCKS* Proxy" @@ -260,15 +267,15 @@ This family builds families dynamically. | Variable                                                                                                                  | Description                                                                                                               | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.https_proxy.address** or **manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "*HTTPS* address" or "*SOCKS* address".
**Validator**: the domain name can be an IP
**Default**: the value of the variable "manual.http_proxy.address". | -| **manual.https_proxy.port** or **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "*HTTPS* port" or "*SOCKS* port".
**Default**: the value of the variable "manual.http_proxy.port". | -| **manual.https_proxy.version** or **manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | SOCKS host version used by proxy.
**Choices**:
- v4
- v5 ← (default)
**Disabled**: when the identifier is "HTTPS". | +| **firefox.manual.https_proxy.address** or **firefox.manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "*HTTPS* address" or "*SOCKS* address".
**Validator**: the domain name can be an IP
**Default**: the value of the variable "firefox.manual.http_proxy.address". | +| **firefox.manual.https_proxy.port** or **firefox.manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "*HTTPS* port" or "*SOCKS* port".
**Default**: the value of the variable "firefox.manual.http_proxy.port". | +| **firefox.manual.https_proxy.version** or **firefox.manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | SOCKS host version used by proxy.
**Choices**:
- v4
- v5 ← (default)
**Disabled**: when the identifier is "HTTPS". | | Variable                                                                                                                  | Description                                                                                                               | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | Automatic proxy configuration URL.
**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL". | -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`disabled`_ `unique` `multiple` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
- 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 "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 "proxy_mode" has the value "No proxy". | +| **firefox.auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | Automatic proxy configuration URL.
**Disabled**: when the variable "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) `standard` _`disabled`_ `unique` `multiple` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
- 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 "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 "firefox.proxy_mode" has the value "No proxy". | #### DNS over HTTPS @@ -276,11 +283,146 @@ This family builds families dynamically. | 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 "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**: must starts with 'https://' only.
**Disabled**: if "dns_over_https.provider" is not "Custom". | +| **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 "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.
**Validator**: must starts with 'https://' only.
**Disabled**: if "dns_over_https.provider" is not "Custom". | +## User data + +### Example 1 + +#### config/01/config.yaml -- [[tutorial 100] xxx](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)) +```yml +--- + +``` +#### Output + +```console +foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u file -ff config/01/config.yaml +``` +
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📂 firefox
+┣━━ 📓 proxy_mode: No proxy
+┗━━ 📂 dns_over_https
+    ┗━━ 📓 enable_dns_over_https: False
+┗━━ 📂 foxyproxy
+
+### Example 2 + +#### config/02/config.yaml + + +```yml +--- +foxyproxy: + proxies: + - title: My company + color: '#66cc66' + type: HTTP + address: proxy.company.net + +``` +#### Output + +```console +foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u file -ff config/02/config.yaml +``` +
🛑 ERRORS
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┗━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📂 firefox
+┣━━ 📓 proxy_mode: No proxy
+┗━━ 📂 dns_over_https
+    ┗━━ 📓 enable_dns_over_https: False
+┗━━ 📂 foxyproxy
+
+### Example 3 + +#### config/03/config.yaml + + +```yml +--- +firefox: + proxy_mode: Manual proxy configuration + manual: + http_proxy: + address: http.proxy.net +foxyproxy: + proxies: + - title: My company + color: '#66cc66' + type: HTTP + - title: An other company + color: '#cc66cc' + type: SOCKS5 + username: my_user + password: my_password + - title: WPAD + color: '#1166cc' + type: WPAD + url: http://wpad.proxy.net/wpad.dat + +``` +#### Output + +```console +foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u file -ff config/03/config.yaml +``` +
🛑 ERRORS
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┗━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📂 firefox
+┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
+┣━━ 📂 manual
+┣━━ 📂 http_proxy
+┣━━ 📓 address: http.proxy.net
+┗━━ 📓 port: 8080
+┣━━ 📓 use_for_https: True
+┣━━ 📂 https_proxy
+┣━━ 📓 address: http.proxy.net
+┗━━ 📓 port: 8080
+┗━━ 📂 socks_proxy
+    ┣━━ 📓 address: http.proxy.net
+    ┣━━ 📓 port: 8080
+    ┗━━ 📓 version: v5
+┣━━ 📓 no_proxy :
+┣━━ 📓 prompt_authentication: True
+┣━━ 📓 proxy_dns_socks5: False
+┗━━ 📂 dns_over_https
+    ┗━━ 📓 enable_dns_over_https: False
+┗━━ 📂 foxyproxy
+
+ + +- [[tutorial 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)) diff --git a/config/01/config.yaml b/config/01/config.yaml new file mode 100644 index 0000000..ed97d53 --- /dev/null +++ b/config/01/config.yaml @@ -0,0 +1 @@ +--- diff --git a/config/01/output_ro.html b/config/01/output_ro.html new file mode 100644 index 0000000..98d49c6 --- /dev/null +++ b/config/01/output_ro.html @@ -0,0 +1,13 @@ +
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📂 firefox
+┣━━ 📓 proxy_mode: No proxy
+┗━━ 📂 dns_over_https
+    ┗━━ 📓 enable_dns_over_https: False
+┗━━ 📂 foxyproxy
+
diff --git a/config/02/config.yaml b/config/02/config.yaml new file mode 100644 index 0000000..ffa7a24 --- /dev/null +++ b/config/02/config.yaml @@ -0,0 +1,7 @@ +--- +foxyproxy: + proxies: + - title: My company + color: '#66cc66' + type: HTTP + address: proxy.company.net diff --git a/config/02/output_ro.html b/config/02/output_ro.html new file mode 100644 index 0000000..fbd721f --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,18 @@ +
🛑 ERRORS
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┗━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📂 firefox
+┣━━ 📓 proxy_mode: No proxy
+┗━━ 📂 dns_over_https
+    ┗━━ 📓 enable_dns_over_https: False
+┗━━ 📂 foxyproxy
+
diff --git a/config/03/config.yaml b/config/03/config.yaml new file mode 100644 index 0000000..bf2cc98 --- /dev/null +++ b/config/03/config.yaml @@ -0,0 +1,20 @@ +--- +firefox: + proxy_mode: Manual proxy configuration + manual: + http_proxy: + address: http.proxy.net +foxyproxy: + proxies: + - title: My company + color: '#66cc66' + type: HTTP + - title: An other company + color: '#cc66cc' + type: SOCKS5 + username: my_user + password: my_password + - title: WPAD + color: '#1166cc' + type: WPAD + url: http://wpad.proxy.net/wpad.dat diff --git a/config/03/output_ro.html b/config/03/output_ro.html new file mode 100644 index 0000000..ca74322 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,35 @@ +
🛑 ERRORS
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┣━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+┗━━ unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
+╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📂 firefox
+┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
+┣━━ 📂 manual
+┣━━ 📂 http_proxy
+┣━━ 📓 address: http.proxy.net
+┗━━ 📓 port: 8080
+┣━━ 📓 use_for_https: True
+┣━━ 📂 https_proxy
+┣━━ 📓 address: http.proxy.net
+┗━━ 📓 port: 8080
+┗━━ 📂 socks_proxy
+    ┣━━ 📓 address: http.proxy.net
+    ┣━━ 📓 port: 8080
+    ┗━━ 📓 version: v5
+┣━━ 📓 no_proxy :
+┣━━ 📓 prompt_authentication: True
+┣━━ 📓 proxy_dns_socks5: False
+┗━━ 📂 dns_over_https
+    ┗━━ 📓 enable_dns_over_https: False
+┗━━ 📂 foxyproxy
+