[tutorial v1.1_027)] Copy HTTP manual proxy to HTTPS manual proxy (config and doc)
This commit is contained in:
parent
9745345124
commit
13eca19caa
6 changed files with 80 additions and 35 deletions
85
README.md
85
README.md
|
|
@ -1,9 +1,9 @@
|
|||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||
- [[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_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_026)] A variable with type "boolean"
|
||||
# [tutorial v1.1_027)] Copy HTTP manual proxy to HTTPS manual proxy
|
||||
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_026~1..v1.1_026)
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_027~1..v1.1_027)
|
||||
|
||||
|
||||
## Screenshot
|
||||
|
|
@ -71,13 +71,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_026
|
||||
foo@bar:~$ git switch --detach v1.1_027
|
||||
foo@bar:~$ rougail -m firefox/ -o doc
|
||||
```
|
||||
| Variable | Description |
|
||||
|
|
@ -105,17 +118,29 @@ foo@bar:~$ rougail -m firefox/ -o doc
|
|||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **manual.use_for_https**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
|
||||
|
||||
##### HTTPS Proxy
|
||||
|
||||
**manual.https_proxy**
|
||||
|
||||
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **manual.https_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.<br/>**Validator**: the domain name can be an IP |
|
||||
| **manual.https_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
|
||||
|
||||
### Let's generate the changelog
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_026
|
||||
foo@bar:~$ git switch --detach v1.1_027
|
||||
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
|
||||
```
|
||||
#### New variable
|
||||
#### New variables
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **manual.use_for_https**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **manual.https_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.<br/>**Validator**: the domain name can be an IP |
|
||||
| **manual.https_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
|
||||
|
||||
|
||||
## User datas
|
||||
|
|
@ -132,14 +157,16 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
|
|||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_026
|
||||
foo@bar:~$ git switch --detach v1.1_027
|
||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
|
||||
```
|
||||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
|
||||
</pre>
|
||||
### Example 2
|
||||
|
||||
|
|
@ -154,14 +181,16 @@ proxy_mode: No proxy
|
|||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_026
|
||||
foo@bar:~$ git switch --detach v1.1_027
|
||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
|
||||
```
|
||||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
|
||||
</pre>
|
||||
### Example 3
|
||||
|
||||
|
|
@ -176,14 +205,16 @@ proxy_mode: Manual proxy configuration
|
|||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_026
|
||||
foo@bar:~$ git switch --detach v1.1_027
|
||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
|
||||
```
|
||||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
|
||||
</pre>
|
||||
### Example 4
|
||||
|
||||
|
|
@ -198,7 +229,7 @@ proxy_mode: foo
|
|||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_026
|
||||
foo@bar:~$ git switch --detach v1.1_027
|
||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
|
||||
```
|
||||
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||||
|
|
@ -207,8 +238,10 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
|
|||
<span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
|
||||
</pre>
|
||||
### Example 5
|
||||
|
||||
|
|
@ -223,7 +256,7 @@ proxy_mode: 1
|
|||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_026
|
||||
foo@bar:~$ git switch --detach v1.1_027
|
||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
|
||||
```
|
||||
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||||
|
|
@ -232,9 +265,11 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
|
|||
<span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
|
||||
</pre>
|
||||
|
||||
|
||||
- [[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))
|
||||
- [[tutorial v1.1_030] A disabled family](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))
|
||||
|
|
|
|||
|
|
@ -1,6 +1,8 @@
|
|||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,8 @@
|
|||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,8 @@
|
|||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
<span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@
|
|||
<span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||||
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
|
||||
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
|
||||
</pre>
|
||||
|
|
|
|||
Loading…
Reference in a new issue