diff --git a/README.md b/README.md
index 4ea8cdf4..77e2ed59 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_024] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_024/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_024~1..v1.1_024))
+- [[tutorial v1.1_025] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_025/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_025~1..v1.1_025))
-# [tutorial v1.1_025)] A variable with type "port"
+# [tutorial v1.1_026)] A variable with type "boolean"
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_025~1..v1.1_025)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_026~1..v1.1_026)
## Screenshot
@@ -59,11 +59,25 @@ manual: # Manual proxy configuration
default: 8080
...
+```
+### firefox/20-manual.yml
+
+
+```yml
+%YAML 1.2
+---
+version: 1.1
+
+manual:
+
+ use_for_https: true # Also use this proxy for HTTPS
+...
+
```
### Let's generate the documentation
```console
-foo@bar:~$ git switch --detach v1.1_025
+foo@bar:~$ git switch --detach v1.1_026
foo@bar:~$ rougail -m firefox/ -o doc
```
| Variable | Description |
@@ -87,17 +101,21 @@ foo@bar:~$ rougail -m firefox/ -o doc
| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `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) `mandatory` | HTTP 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 |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true |
+
### Let's generate the changelog
```console
-foo@bar:~$ git switch --detach v1.1_025
+foo@bar:~$ git switch --detach v1.1_026
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
```
#### New variable
-| Variable | Description |
-|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP 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 |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true |
## User datas
@@ -114,7 +132,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
#### Output
```console
-foo@bar:~$ git switch --detach v1.1_025
+foo@bar:~$ git switch --detach v1.1_026
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
```
🛑 ERRORS @@ -123,18 +141,6 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml ┗━━ HTTP Proxy ┗━━ HTTP address-#### Output in read write mode - -```console -foo@bar:~$ git switch --detach v1.1_025 -foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_write -``` -
🛑 ERRORS -┗━━ The following variables are mandatory but have no value: - ┗━━ Manual proxy configuration - ┗━━ HTTP Proxy - ┗━━ HTTP address -### Example 2 #### config/02/config.yaml @@ -142,13 +148,13 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_writ ```yml --- -proxy_mode: Manual proxy configuration +proxy_mode: No proxy ``` #### Output ```console -foo@bar:~$ git switch --detach v1.1_025 +foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml ```
🛑 ERRORS @@ -157,18 +163,6 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml ┗━━ HTTP Proxy ┗━━ HTTP address-#### Output in read write mode - -```console -foo@bar:~$ git switch --detach v1.1_025 -foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_write -``` -
🛑 ERRORS -┗━━ The following variables are mandatory but have no value: - ┗━━ Manual proxy configuration - ┗━━ HTTP Proxy - ┗━━ HTTP address -### Example 3 #### config/03/config.yaml @@ -177,46 +171,19 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_writ ```yml --- proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: example.net ``` #### Output ```console -foo@bar:~$ git switch --detach v1.1_025 +foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml ``` -
╭────────────── Caption ───────────────╮ -│ Variable Default value │ -│ Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml" - ┗━━ 📓 HTTP Port: 8080 --#### Output in read write mode - -```console -foo@bar:~$ git switch --detach v1.1_025 -foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_write -``` -
╭────────────── Caption ───────────────╮ -│ Variable Default value │ -│ Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml" - ┗━━ 📓 HTTP Port: 8080 +🛑 ERRORS +┗━━ The following variables are mandatory but have no value: + ┗━━ Manual proxy configuration + ┗━━ HTTP Proxy + ┗━━ HTTP address### Example 4 @@ -225,46 +192,23 @@ Variables: ```yml --- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: example.net - port: '3128' +proxy_mode: foo ``` #### Output ```console -foo@bar:~$ git switch --detach v1.1_025 +foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml ``` -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml" - ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ 8080) --#### Output in read write mode - -```console -foo@bar:~$ git switch --detach v1.1_025 -foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write -``` -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml" - ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ 8080) +🔔 WARNINGS +┗━━ the value "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, it will be ignored when loading from the YAML file "config/04/config.yaml" +🛑 ERRORS +┗━━ The following variables are mandatory but have no value: + ┗━━ Manual proxy configuration + ┗━━ HTTP Proxy + ┗━━ HTTP address### Example 5 @@ -273,56 +217,24 @@ Variables: ```yml --- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: '3128' - use_for_https: false - https_proxy: - address: https.proxy.net +proxy_mode: 1 ``` #### Output ```console -foo@bar:~$ git switch --detach v1.1_025 +foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml ```🔔 WARNINGS -┣━━ variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" -┗━━ variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml" - ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ 8080) --#### Output in read write mode - -```console -foo@bar:~$ git switch --detach v1.1_025 -foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write -``` -🔔 WARNINGS -┣━━ variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" -┗━━ variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml" - ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ 8080) +┗━━ the value "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, it will be ignored when loading from the YAML file "config/05/config.yaml" +🛑 ERRORS +┗━━ The following variables are mandatory but have no value: + ┗━━ Manual proxy configuration + ┗━━ HTTP Proxy + ┗━━ HTTP address-- [[tutorial v1.1_026] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_026/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_026~1..v1.1_026)) +- [[tutorial v1.1_027] Copy HTTP manual proxy to HTTPS manual proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_027/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_027~1..v1.1_027)) diff --git a/config/01/output_rw.html b/config/01/output_rw.html deleted file mode 100644 index ec666c15..00000000 --- a/config/01/output_rw.html +++ /dev/null @@ -1,6 +0,0 @@ -🛑 ERRORS -┗━━ The following variables are mandatory but have no value: - ┗━━ Manual proxy configuration - ┗━━ HTTP Proxy - ┗━━ HTTP address -diff --git a/config/02/config.yaml b/config/02/config.yaml index 74edb225..d9144882 100644 --- a/config/02/config.yaml +++ b/config/02/config.yaml @@ -1,2 +1,2 @@ --- -proxy_mode: Manual proxy configuration +proxy_mode: No proxy diff --git a/config/02/output_rw.html b/config/02/output_rw.html deleted file mode 100644 index ec666c15..00000000 --- a/config/02/output_rw.html +++ /dev/null @@ -1,6 +0,0 @@ -🛑 ERRORS -┗━━ The following variables are mandatory but have no value: - ┗━━ Manual proxy configuration - ┗━━ HTTP Proxy - ┗━━ HTTP address -diff --git a/config/03/config.yaml b/config/03/config.yaml index e3db924b..74edb225 100644 --- a/config/03/config.yaml +++ b/config/03/config.yaml @@ -1,5 +1,2 @@ --- proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: example.net diff --git a/config/03/output_ro.html b/config/03/output_ro.html index f89e24f4..ec666c15 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,12 +1,6 @@ -╭────────────── Caption ───────────────╮ -│ Variable Default value │ -│ Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml" - ┗━━ 📓 HTTP Port: 8080 +🛑 ERRORS +┗━━ The following variables are mandatory but have no value: + ┗━━ Manual proxy configuration + ┗━━ HTTP Proxy + ┗━━ HTTP addressdiff --git a/config/03/output_rw.html b/config/03/output_rw.html deleted file mode 100644 index f89e24f4..00000000 --- a/config/03/output_rw.html +++ /dev/null @@ -1,12 +0,0 @@ -╭────────────── Caption ───────────────╮ -│ Variable Default value │ -│ Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml" - ┗━━ 📓 HTTP Port: 8080 -diff --git a/config/04/config.yaml b/config/04/config.yaml index c8d73af3..e3fa25da 100644 --- a/config/04/config.yaml +++ b/config/04/config.yaml @@ -1,6 +1,2 @@ --- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: example.net - port: '3128' +proxy_mode: foo diff --git a/config/04/output_ro.html b/config/04/output_ro.html index 4d0ae5a0..82882481 100644 --- a/config/04/output_ro.html +++ b/config/04/output_ro.html @@ -1,11 +1,9 @@ -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml" - ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ 8080) +🔔 WARNINGS +┗━━ the value "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, it will be ignored when loading from the YAML file "config/04/config.yaml" +🛑 ERRORS +┗━━ The following variables are mandatory but have no value: + ┗━━ Manual proxy configuration + ┗━━ HTTP Proxy + ┗━━ HTTP addressdiff --git a/config/04/output_rw.html b/config/04/output_rw.html deleted file mode 100644 index 4d0ae5a0..00000000 --- a/config/04/output_rw.html +++ /dev/null @@ -1,11 +0,0 @@ -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml" - ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ 8080) -diff --git a/config/05/config.yaml b/config/05/config.yaml index 4a1f7890..bf6f64ca 100644 --- a/config/05/config.yaml +++ b/config/05/config.yaml @@ -1,9 +1,2 @@ --- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: '3128' - use_for_https: false - https_proxy: - address: https.proxy.net +proxy_mode: 1 diff --git a/config/05/output_ro.html b/config/05/output_ro.html index 0438b8ae..1c53cef3 100644 --- a/config/05/output_ro.html +++ b/config/05/output_ro.html @@ -1,14 +1,9 @@🔔 WARNINGS -┣━━ variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" -┗━━ variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml" - ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ 8080) +┗━━ the value "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, it will be ignored when loading from the YAML file "config/05/config.yaml" +🛑 ERRORS +┗━━ The following variables are mandatory but have no value: + ┗━━ Manual proxy configuration + ┗━━ HTTP Proxy + ┗━━ HTTP addressdiff --git a/config/05/output_rw.html b/config/05/output_rw.html deleted file mode 100644 index 0438b8ae..00000000 --- a/config/05/output_rw.html +++ /dev/null @@ -1,14 +0,0 @@ -🔔 WARNINGS -┣━━ variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" -┗━━ variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ -Variables: -┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ No proxy) -┗━━ 📂 Manual proxy configuration - ┗━━ 📂 HTTP Proxy - ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml" - ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ 8080) -diff --git a/firefox.png b/firefox.png index e40ce963..b7ca7aa0 100644 Binary files a/firefox.png and b/firefox.png differ