From bfa1cd70035350505bf03b6a1d93590ad0ea8176 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sat, 2 Nov 2024 14:58:47 +0100 Subject: [PATCH] [tutorial 074] Help (config and doc) --- README.md | 84 +++++++++++----------------------------- config/02/config.yaml | 3 +- config/02/output_ro.html | 4 +- config/03/config.yaml | 6 ++- config/03/output_ro.html | 16 ++++++-- config/04/config.yaml | 2 - config/04/output_ro.html | 13 ------- config/05/config.yaml | 2 - config/05/output_ro.html | 13 ------- 9 files changed, 44 insertions(+), 99 deletions(-) delete mode 100644 config/04/config.yaml delete mode 100644 config/04/output_ro.html delete mode 100644 config/05/config.yaml delete mode 100644 config/05/output_ro.html diff --git a/README.md b/README.md index 9d19936..921d4ae 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 072] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_072/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072)) +- [[tutorial 073] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_073/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_073~1..v1.1_073)) -# [tutorial 073] Examples +# [tutorial 074] Help -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_073~1..v1.1_073) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_074~1..v1.1_074) ## Screenshot @@ -137,6 +137,7 @@ no_proxy: - .mozilla.org - .net.nz - 192.168.1.0/24 + help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied ``` ### Generated documentation @@ -187,7 +188,7 @@ This family builds families dynamically. | Variable                                                                                                                                                                                  | Description                                                                                                                                                                               | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` _`disabled`_ | Automatic proxy configuration URL.
**Disabled**: proxy_mode. | -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) _`disabled`_ `unique` `multiple` | Address for which proxy will be desactivated.
**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**: proxy_mode. | +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) _`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**: proxy_mode. | ## User data @@ -222,7 +223,8 @@ Variables: ```yml --- -proxy_mode: No proxy +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat ``` #### Output @@ -237,7 +239,9 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml │ Unmodifiable variable │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┗━━ 📓 proxy_mode: No proxy (No proxy) +┣━━ 📓 proxy_mode: Automatic proxy configuration URL (No proxy) +┣━━ 📓 auto: https://auto.proxy.net/wpad.dat +┗━━ 📓 no_proxy : ### Example 3 @@ -246,7 +250,11 @@ Variables: ```yml --- -proxy_mode: Manual proxy configuration +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat +no_proxy: + - .example.net + - 192.168.1.0/24 ``` #### Output @@ -254,67 +262,19 @@ proxy_mode: Manual proxy configuration ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml ``` -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┣━━   - manual.http_proxy.address (HTTP address)
-┗━━   - manual.socks_proxy.address (SOCKS address)
-
-### Example 4 - -#### config/04/config.yaml - - -```yml ---- -proxy_mode: foo - -``` -#### Output - -```console -foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml -``` -
🛑 ERRORS
-┗━━ "foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only 
-    "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
-    configuration", "No proxy" and "Use system proxy settings" are allowed
-╭────────────────────────── Caption ──────────────────────────╮
+
╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           Default value            │
 │ Undocumented variable              Modified value           │
 │ Undocumented but modified variable (Original default value) │
 │ Unmodifiable variable                                       │
 ╰─────────────────────────────────────────────────────────────╯
 Variables:
-┗━━ 📓 proxy_mode: No proxy
-

-### Example 5
-
-#### config/05/config.yaml
-
-
-```yml
----
-proxy_mode: 1
-
-```
-#### Output
-
-```console
-foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
-```
-
🛑 ERRORS
-┗━━ "1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
-    proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", 
-    "No proxy" and "Use system proxy settings" are allowed
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy
+┣━━ 📓 proxy_mode: Automatic proxy configuration URL (No proxy)
+┣━━ 📓 auto: https://auto.proxy.net/wpad.dat
+┗━━ 📓 no_proxy :
+    ┣━━ .example.net
+    ┗━━ 192.168.1.0/24
 

 
 
-- [[tutorial 074] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_074/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_074~1..v1.1_074))
+- [[tutorial 075] A variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_075/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_075~1..v1.1_075))
diff --git a/config/02/config.yaml b/config/02/config.yaml
index d914488..307e175 100644
--- a/config/02/config.yaml
+++ b/config/02/config.yaml
@@ -1,2 +1,3 @@
 ---
-proxy_mode: No proxy
+proxy_mode: Automatic proxy configuration URL
+auto: https://auto.proxy.net/wpad.dat
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index 38b2d86..dc91e67 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -5,5 +5,7 @@
 │ Unmodifiable variable                                       │
 ╰─────────────────────────────────────────────────────────────╯
 Variables:
-┗━━ 📓 proxy_mode: No proxy (No proxy)
+┣━━ 📓 proxy_mode: Automatic proxy configuration URL (No proxy)
+┣━━ 📓 auto: https://auto.proxy.net/wpad.dat
+┗━━ 📓 no_proxy :
diff --git a/config/03/config.yaml b/config/03/config.yaml index 74edb22..5319897 100644 --- a/config/03/config.yaml +++ b/config/03/config.yaml @@ -1,2 +1,6 @@ --- -proxy_mode: Manual proxy configuration +proxy_mode: Automatic proxy configuration URL +auto: https://auto.proxy.net/wpad.dat +no_proxy: + - .example.net + - 192.168.1.0/24 diff --git a/config/03/output_ro.html b/config/03/output_ro.html index 15e7f44..f0c5640 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,5 +1,13 @@ -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┣━━   - manual.http_proxy.address (HTTP address)
-┗━━   - manual.socks_proxy.address (SOCKS address)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode: Automatic proxy configuration URL (No proxy)
+┣━━ 📓 auto: https://auto.proxy.net/wpad.dat
+┗━━ 📓 no_proxy :
+    ┣━━ .example.net
+    ┗━━ 192.168.1.0/24
 

diff --git a/config/04/config.yaml b/config/04/config.yaml
deleted file mode 100644
index e3fa25d..0000000
--- a/config/04/config.yaml
+++ /dev/null
@@ -1,2 +0,0 @@
----
-proxy_mode: foo
diff --git a/config/04/output_ro.html b/config/04/output_ro.html
deleted file mode 100644
index 5fe2e0d..0000000
--- a/config/04/output_ro.html
+++ /dev/null
@@ -1,13 +0,0 @@
-
🛑 ERRORS
-┗━━ "foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only 
-    "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
-    configuration", "No proxy" and "Use system proxy settings" are allowed
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy
-

diff --git a/config/05/config.yaml b/config/05/config.yaml
deleted file mode 100644
index bf6f64c..0000000
--- a/config/05/config.yaml
+++ /dev/null
@@ -1,2 +0,0 @@
----
-proxy_mode: 1
diff --git a/config/05/output_ro.html b/config/05/output_ro.html
deleted file mode 100644
index 071b4d5..0000000
--- a/config/05/output_ro.html
+++ /dev/null
@@ -1,13 +0,0 @@
-
🛑 ERRORS
-┗━━ "1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
-    proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration", 
-    "No proxy" and "Use system proxy settings" are allowed
-╭────────────────────────── Caption ──────────────────────────╮
-│ Variable                           Default value            │
-│ Undocumented variable              Modified value           │
-│ Undocumented but modified variable (Original default value) │
-│ Unmodifiable variable                                       │
-╰─────────────────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 proxy_mode: No proxy
-