From 018faef6779fc081a675dad09e204c1c15de2e70 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sat, 2 Nov 2024 14:59:01 +0100 Subject: [PATCH] [tutorial 101] xxx (config and doc) --- README.md | 70 ++++++++++++++++++++++++++++++---------- config/01/output_ro.html | 3 +- config/02/output_ro.html | 12 ++++--- config/03/output_ro.html | 22 +++++++++---- 4 files changed, 77 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index c12fcc9..60db81c 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 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 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)) -# [tutorial 100] xxx +# [tutorial 101] xxx -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101) ## Screenshot @@ -222,6 +222,16 @@ dns_over_https: # DNS over HTTPS ```yml --- +proxies: + description: Proxy configuration + type: leadership + + title: + description: Title or Description + mandatory: false + + color: + description: Color ``` ### Generated documentation @@ -288,6 +298,21 @@ This family builds families dynamically. | **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". | +### Variables for "foxyproxy" + +#### Proxy configuration + +`basic` + + +This family contains lists of variable blocks. + +| Variable                                                                                                | Description                                                                                             | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | Title or Description. | +| **foxyproxy.proxies.color**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Color. | + + ## User data ### Example 1 @@ -315,7 +340,8 @@ Variables: ┃ ┣━━ 📓 proxy_mode: No proxy ┃ ┗━━ 📂 dns_over_https ┃ ┗━━ 📓 enable_dns_over_https: False -┗━━ 📂 foxyproxy +┗━━ 📂 foxyproxy + ┗━━ 📂 proxies ### Example 2 @@ -338,10 +364,8 @@ foxyproxy: 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)
+┣━━ unknown option "type" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+┗━━ unknown option "address" in optiondescription "foxyproxy.proxies" (Proxy configuration)
 ╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           Default value            │
 │ Undocumented variable              Modified value           │
@@ -353,7 +377,11 @@ Variables:
 ┃   ┣━━ 📓 proxy_mode: No proxy
 ┃   ┗━━ 📂 dns_over_https
 ┃       ┗━━ 📓 enable_dns_over_https: False
-┗━━ 📂 foxyproxy
+┗━━ 📂 foxyproxy
+    ┗━━ 📂 proxies
+        ┗━━ 📂 title
+            ┣━━ 📓 title: My company
+            ┗━━ 📓 color: #66cc66
### Example 3 @@ -389,12 +417,10 @@ foxyproxy: 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)
+┣━━ unknown option "url" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+┣━━ unknown option "username" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+┣━━ unknown option "type" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+┗━━ unknown option "password" in optiondescription "foxyproxy.proxies" (Proxy configuration)
 ╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           Default value            │
 │ Undocumented variable              Modified value           │
@@ -421,8 +447,18 @@ Variables:
 ┃   ┣━━ 📓 proxy_dns_socks5: False
 ┃   ┗━━ 📂 dns_over_https
 ┃       ┗━━ 📓 enable_dns_over_https: False
-┗━━ 📂 foxyproxy
+┗━━ 📂 foxyproxy
+    ┗━━ 📂 proxies
+        ┣━━ 📂 title
+        ┃   ┣━━ 📓 title: My company
+        ┃   ┗━━ 📓 color: #66cc66
+        ┣━━ 📂 title
+        ┃   ┣━━ 📓 title: An other company
+        ┃   ┗━━ 📓 color: #cc66cc
+        ┗━━ 📂 title
+            ┣━━ 📓 title: WPAD
+            ┗━━ 📓 color: #1166cc
-- [[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)) +- [[tutorial 102] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 98d49c6..c3c7ebe 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -9,5 +9,6 @@ Variables: ┃ ┣━━ 📓 proxy_mode: No proxy ┃ ┗━━ 📂 dns_over_https ┃ ┗━━ 📓 enable_dns_over_https: False -┗━━ 📂 foxyproxy +┗━━ 📂 foxyproxy + ┗━━ 📂 proxies diff --git a/config/02/output_ro.html b/config/02/output_ro.html index fbd721f..c9b105a 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,8 +1,6 @@ 
🛑 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 "type" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+┗━━ unknown option "address" in optiondescription "foxyproxy.proxies" (Proxy configuration)
 ╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           Default value            │
 │ Undocumented variable              Modified value           │
@@ -14,5 +12,9 @@ Variables:
 ┃   ┣━━ 📓 proxy_mode: No proxy
 ┃   ┗━━ 📂 dns_over_https
 ┃       ┗━━ 📓 enable_dns_over_https: False
-┗━━ 📂 foxyproxy
+┗━━ 📂 foxyproxy
+    ┗━━ 📂 proxies
+        ┗━━ 📂 title
+            ┣━━ 📓 title: My company
+            ┗━━ 📓 color: #66cc66
diff --git a/config/03/output_ro.html b/config/03/output_ro.html index ca74322..8072fed 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,10 +1,8 @@ 
🛑 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)
+┣━━ unknown option "url" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+┣━━ unknown option "username" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+┣━━ unknown option "type" in optiondescription "foxyproxy.proxies" (Proxy configuration)
+┗━━ unknown option "password" in optiondescription "foxyproxy.proxies" (Proxy configuration)
 ╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           Default value            │
 │ Undocumented variable              Modified value           │
@@ -31,5 +29,15 @@ Variables:
 ┃   ┣━━ 📓 proxy_dns_socks5: False
 ┃   ┗━━ 📂 dns_over_https
 ┃       ┗━━ 📓 enable_dns_over_https: False
-┗━━ 📂 foxyproxy
+┗━━ 📂 foxyproxy
+    ┗━━ 📂 proxies
+        ┣━━ 📂 title
+        ┃   ┣━━ 📓 title: My company
+        ┃   ┗━━ 📓 color: #66cc66
+        ┣━━ 📂 title
+        ┃   ┣━━ 📓 title: An other company
+        ┃   ┗━━ 📓 color: #cc66cc
+        ┗━━ 📂 title
+            ┣━━ 📓 title: WPAD
+            ┗━━ 📓 color: #1166cc