From 5265f0ae4ad296e17eafe06b29fe97d27a93f00b Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Mon, 9 Mar 2026 07:58:58 +0100 Subject: [PATCH] [tutorial v1.1_151] New "FoxyProxy" namespace (config and doc) --- README.md | 212 +++++++++++++++++++++------------------ config/01/cmd_ro.txt | 2 +- config/01/config.yml | 2 - config/01/output_ro.html | 7 +- config/02/cmd_ro.txt | 1 + config/02/config.yml | 7 ++ config/02/output_ro.html | 24 +++++ config/03/cmd_ro.txt | 1 + config/03/config.yml | 20 ++++ config/03/output_ro.html | 25 +++++ tree.html | 28 +++--- 11 files changed, 207 insertions(+), 122 deletions(-) create mode 100644 config/02/cmd_ro.txt create mode 100644 config/02/config.yml create mode 100644 config/02/output_ro.html create mode 100644 config/03/cmd_ro.txt create mode 100644 config/03/config.yml create mode 100644 config/03/output_ro.html diff --git a/README.md b/README.md index 3e93ae45..d25e9c64 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_140] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_140/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_150~1..v1.1_150)) +- [[tutorial v1.1_150] Namespace](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_151~1..v1.1_151)) -# [tutorial v1.1_150] Namespace +# [tutorial v1.1_151] New "FoxyProxy" namespace -[Read the tutorial "Namespace" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#namespace) +[Read the tutorial "New "FoxyProxy" namespace" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#new-foxyproxy-namespace) ## Screenshot -Firefox Proxy setting +Firefox Proxy setting ## Clone and install @@ -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_151 ``` ## Structure @@ -37,56 +37,29 @@ 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
+ ├── foxyproxy
+ │   └── 00-foxyproxy.yml
+ └── types
+     └── proxy
+         └── 00_type.yml


-Contents of the firefox/60-dns_over_https.yml file +Contents of the foxyproxy/00-foxyproxy.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" ... ``` @@ -95,7 +68,7 @@ dns_over_https: # DNS over HTTPS ### Let's generate the documentation ```shell -rougail -m firefox/ -s Firefox --types types/proxy --modes_level basic standard advanced -o doc +rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc ``` #### Firefox @@ -180,52 +153,6 @@ rougail -m firefox/ -s Firefox --types types/proxy --modes_level basic standard | **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/ -s Firefox --types types/proxy --modes_level basic standard advanced -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml -``` -#### New variables - -| 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) `basic` `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP | -| **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**: 8080 | -| **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 @@ -236,19 +163,55 @@ rougail -m firefox/ -s Firefox --types types/proxy --modes_level basic standard ```yml --- -dns_over_https: - enable_dns_over_https: true ``` *** #### Output ```shell -rougail -m firefox/ -s Firefox --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml +rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml +``` +> [!NOTE] +> +> **Caption:** +> - Variable +> - Default value + +Variables: +- :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): false + +*** +### Example 2 + +#### config/02/config.yml + + +```yml +--- +foxyproxy: + proxies: + - title: My company + color: '#66cc66' + type: HTTP + address: proxy.company.net +``` + +*** +#### Output + +```shell +rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/02/config.yml ``` > [!WARNING] > -> - variable or family "dns_over_https" does not exist so cannot load "dns_over_https.enable_dns_over_https", it will be ignored when loading from the YAML file "config/01/config.yml" +> - foxyproxy (FoxyProxy) +> - :bell: variable or family "proxies" does not exist so cannot load "foxyproxy.proxies.title", it will be ignored when loading from the YAML file "config/02/config.yml" +> - :bell: variable or family "proxies" does not exist so cannot load "foxyproxy.proxies.color", it will be ignored when loading from the YAML file "config/02/config.yml" +> - :bell: variable or family "proxies" does not exist so cannot load "foxyproxy.proxies.type", it will be ignored when loading from the YAML file "config/02/config.yml" +> - :bell: variable or family "proxies" does not exist so cannot load "foxyproxy.proxies.address", it will be ignored when loading from the YAML file "config/02/config.yml" > [!NOTE] > @@ -263,6 +226,55 @@ Variables: - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false *** +### Example 3 + +#### config/03/config.yml -- [[tutorial v1.1_151] New "FoxyProxy" namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_151/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_151~1..v1.1_151)) +```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 + +```shell +rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/03/config.yml +``` +> [!CAUTION] +> +> - foxyproxy (FoxyProxy) +> - :bell: variable or family "proxies" does not exist so cannot load "foxyproxy.proxies.title", it will be ignored when loading from the YAML file "config/03/config.yml" +> - :bell: variable or family "proxies" does not exist so cannot load "foxyproxy.proxies.color", it will be ignored when loading from the YAML file "config/03/config.yml" +> - :bell: variable or family "proxies" does not exist so cannot load "foxyproxy.proxies.type", it will be ignored when loading from the YAML file "config/03/config.yml" +> - :bell: variable or family "proxies" does not exist so cannot load "foxyproxy.proxies.username", it will be ignored when loading from the YAML file "config/03/config.yml" +> - :bell: variable or family "proxies" does not exist so cannot load "foxyproxy.proxies.password", it will be ignored when loading from the YAML file "config/03/config.yml" +> - :bell: variable or family "proxies" does not exist so cannot load "foxyproxy.proxies.url", it will be ignored when loading from the YAML file "config/03/config.yml" +> - firefox (Firefox) +> - manual (Manual proxy configuration) +> - socks_proxy (SOCKS Proxy) +> - address (Proxy address): :stop_sign: mandatory variable but has no value + +*** + + +- [[tutorial v1.1_160] A leadership family](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)) diff --git a/config/01/cmd_ro.txt b/config/01/cmd_ro.txt index 33259451..776c1590 100644 --- a/config/01/cmd_ro.txt +++ b/config/01/cmd_ro.txt @@ -1 +1 @@ -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 +rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --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 aee4796f..ed97d539 100644 --- a/config/01/config.yml +++ b/config/01/config.yml @@ -1,3 +1 @@ --- -dns_over_https: - enable_dns_over_https: true diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 514bbe3f..aa0e837f 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,9 +1,4 @@ -
🔔 Warning
-┗━━ variable or family "dns_over_https" does not exist so cannot load 
-    "dns_over_https.enable_dns_over_https", it will be ignored when loading from
-    the YAML file "config/01/config.yml"
-
-╭─────── Caption ────────╮
+
╭─────── Caption ────────╮
 │ Variable Default value │
 ╰────────────────────────╯
 Variables:
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt
new file mode 100644
index 00000000..0841fc15
--- /dev/null
+++ b/config/02/cmd_ro.txt
@@ -0,0 +1 @@
+rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --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
new file mode 100644
index 00000000..ffa7a240
--- /dev/null
+++ b/config/02/config.yml
@@ -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 00000000..cb083171
--- /dev/null
+++ b/config/02/output_ro.html
@@ -0,0 +1,24 @@
+
🔔 Warning
+┗━━ foxyproxy (FoxyProxy)
+    ┣━━ 🔔 variable or family "proxies" does not exist so cannot load 
+    "foxyproxy.proxies.title", it will be ignored when loading from the YAML
+    file "config/02/config.yml"
+    ┣━━ 🔔 variable or family "proxies" does not exist so cannot load 
+    "foxyproxy.proxies.color", it will be ignored when loading from the YAML
+    file "config/02/config.yml"
+    ┣━━ 🔔 variable or family "proxies" does not exist so cannot load 
+    "foxyproxy.proxies.type", it will be ignored when loading from the YAML 
+    file "config/02/config.yml"
+    ┗━━ 🔔 variable or family "proxies" does not exist so cannot load 
+        "foxyproxy.proxies.address", it will be ignored when loading from the 
+        YAML file "config/02/config.yml"
+
+╭─────── Caption ────────╮
+│ Variable Default value │
+╰────────────────────────╯
+Variables:
+┗━━ 📂 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): false
+
diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt new file mode 100644 index 00000000..70205a54 --- /dev/null +++ b/config/03/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --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 new file mode 100644 index 00000000..bf2cc98b --- /dev/null +++ b/config/03/config.yml @@ -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 00000000..3476bdd2 --- /dev/null +++ b/config/03/output_ro.html @@ -0,0 +1,25 @@ +
🛑 Caution
+┣━━ foxyproxy (FoxyProxy)
+┣━━ 🔔 variable or family "proxies" does not exist so cannot load 
+"foxyproxy.proxies.title", it will be ignored when loading from the YAML
+file "config/03/config.yml"
+┣━━ 🔔 variable or family "proxies" does not exist so cannot load 
+"foxyproxy.proxies.color", it will be ignored when loading from the YAML
+file "config/03/config.yml"
+┣━━ 🔔 variable or family "proxies" does not exist so cannot load 
+"foxyproxy.proxies.type", it will be ignored when loading from the YAML 
+file "config/03/config.yml"
+┣━━ 🔔 variable or family "proxies" does not exist so cannot load 
+"foxyproxy.proxies.username", it will be ignored when loading from the 
+YAML file "config/03/config.yml"
+┣━━ 🔔 variable or family "proxies" does not exist so cannot load 
+"foxyproxy.proxies.password", it will be ignored when loading from the 
+YAML file "config/03/config.yml"
+┗━━ 🔔 variable or family "proxies" does not exist so cannot load 
+    "foxyproxy.proxies.url", it will be ignored when loading from the YAML 
+    file "config/03/config.yml"
+┗━━ firefox (Firefox)
+    ┗━━ manual (Manual proxy configuration)
+        ┗━━ socks_proxy (SOCKS Proxy)
+            ┗━━ address (Proxy address): 🛑 mandatory variable but has no value
+
diff --git a/tree.html b/tree.html index b24d1a0b..8b776108 100644 --- a/tree.html +++ b/tree.html @@ -1,15 +1,17 @@

-.
- ├── 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
+ ├── foxyproxy
+ │   └── 00-foxyproxy.yml
+ └── types
+     └── proxy
+         └── 00_type.yml


\ No newline at end of file