diff --git a/README.md b/README.md
index 4d5008b2..bdb81928 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_027] A conditional disabled family with a variable](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))
+- [[tutorial v1.1_030] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030))
-# [tutorial v1.1_030)] A variable with type "boolean"
+# [tutorial v1.1_031)] Copy HTTP manual proxy to HTTPS manual proxy
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031)
## Screenshot
@@ -75,13 +75,26 @@ version: 1.1
manual:
use_for_https: true # Also use this proxy for HTTPS
+
+ https_proxy: # HTTPS Proxy
+
+ address:
+ description: HTTPS address
+ type: domainname
+ params:
+ allow_ip: true
+
+ port:
+ description: HTTPS Port
+ type: port
+ default: 8080
...
```
### Let's generate the documentation
```console
-foo@bar:~$ git switch --detach v1.1_030
+foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -o doc -do github
```
| Variable | Description |
@@ -111,17 +124,29 @@ foo@bar:~$ rougail -m firefox/ -o doc -do github
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true |
+##### HTTPS Proxy
+
+**manual.https_proxy**
+
+
+
+| Variable | Description |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validator**: the domain name can be an IP |
+| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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 |
+
### Let's generate the changelog
```console
-foo@bar:~$ git switch --detach v1.1_030
+foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
```
-#### New variable
+#### New variables
-| 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 |
+| Variable | Description |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validator**: the domain name can be an IP |
+| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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 |
## User datas
@@ -138,7 +163,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
#### Output
```console
-foo@bar:~$ git switch --detach v1.1_030
+foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
```
╭─────── Caption ────────╮ @@ -160,7 +185,7 @@ proxy_mode: No proxy #### Output ```console -foo@bar:~$ git switch --detach v1.1_030 +foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml ```╭────────────── Caption ───────────────╮ @@ -183,14 +208,16 @@ proxy_mode: Manual proxy configuration #### Output ```console -foo@bar:~$ git switch --detach v1.1_030 +foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml ```🛑 ERRORS ┗━━ The following variables are mandatory but have no value: ┗━━ Manual proxy configuration - ┗━━ HTTP Proxy - ┗━━ HTTP address + ┣━━ HTTP Proxy + ┃ ┗━━ HTTP address + ┗━━ HTTPS Proxy + ┗━━ HTTPS address### Example 4 @@ -205,7 +232,7 @@ proxy_mode: foo #### Output ```console -foo@bar:~$ git switch --detach v1.1_030 +foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml ```🔔 WARNINGS @@ -230,7 +257,7 @@ proxy_mode: 1 #### Output ```console -foo@bar:~$ git switch --detach v1.1_030 +foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml ```🔔 WARNINGS @@ -244,4 +271,4 @@ Variables:-- [[tutorial v1.1_031] Copy HTTP manual proxy to HTTPS manual proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031)) +- [[tutorial v1.1_032] An hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032)) diff --git a/config/03/output_ro.html b/config/03/output_ro.html index ec666c15..45e42766 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,6 +1,8 @@🛑 ERRORS ┗━━ The following variables are mandatory but have no value: ┗━━ Manual proxy configuration - ┗━━ HTTP Proxy - ┗━━ HTTP address + ┣━━ HTTP Proxy + ┃ ┗━━ HTTP address + ┗━━ HTTPS Proxy + ┗━━ HTTPS address