|
|
|
|
@ -1,9 +1,9 @@
|
|
|
|
|
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
|
|
|
|
- [[tutorial v1.1_012] Putting a variable inside of a family or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_012/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012))
|
|
|
|
|
- [[tutorial v1.1_020] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020))
|
|
|
|
|
|
|
|
|
|
# [tutorial v1.1_020)] A variable with type "domainname"
|
|
|
|
|
# [tutorial v1.1_021)] A variable with type's parameters
|
|
|
|
|
|
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020)
|
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Screenshot
|
|
|
|
|
@ -50,13 +50,15 @@ manual: # Manual proxy configuration
|
|
|
|
|
address:
|
|
|
|
|
description: HTTP address
|
|
|
|
|
type: domainname
|
|
|
|
|
params:
|
|
|
|
|
allow_ip: true
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
### Let's generate the documentation
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_021
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -o doc
|
|
|
|
|
```
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
@ -77,242 +79,21 @@ foo@bar:~$ rougail -m firefox/ -o doc
|
|
|
|
|
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| **manual.http_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. |
|
|
|
|
|
| **manual.http_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validator**: the domain name can be an IP |
|
|
|
|
|
|
|
|
|
|
### Let's generate the changelog
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_021
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
|
|
|
|
|
```
|
|
|
|
|
#### Modified variable
|
|
|
|
|
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| **manual.http_proxy.address**<br/>~~`string`~~ [<ins>`domainname`</ins>](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. |
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| **manual.http_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validator**: <ins>the domain name can be an IP</ins> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## User datas
|
|
|
|
|
|
|
|
|
|
### Example 1
|
|
|
|
|
|
|
|
|
|
#### config/01/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
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
|
|
|
|
|
</pre>
|
|
|
|
|
#### Output in read write mode
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_write
|
|
|
|
|
```
|
|
|
|
|
<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
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 2
|
|
|
|
|
|
|
|
|
|
#### config/02/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: Manual proxy configuration
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
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
|
|
|
|
|
</pre>
|
|
|
|
|
#### Output in read write mode
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_write
|
|
|
|
|
```
|
|
|
|
|
<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
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 3
|
|
|
|
|
|
|
|
|
|
#### config/03/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: Manual proxy configuration
|
|
|
|
|
manual:
|
|
|
|
|
http_proxy:
|
|
|
|
|
address: example.net
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭────────────── Caption ───────────────╮
|
|
|
|
|
│ Variable Modified value │
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 HTTP Proxy
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
#### Output in read write mode
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_write
|
|
|
|
|
```
|
|
|
|
|
<pre>╭────────────── Caption ───────────────╮
|
|
|
|
|
│ Variable Modified value │
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 HTTP Proxy
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP address: example.net ◀ loaded from the YAML file "config/03/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 4
|
|
|
|
|
|
|
|
|
|
#### config/04/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: Manual proxy configuration
|
|
|
|
|
manual:
|
|
|
|
|
http_proxy:
|
|
|
|
|
address: example.net
|
|
|
|
|
port: '3128'
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
|
|
|
|
<span style="color: #ffff00">┗━━ </span>variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/04/config.yaml"
|
|
|
|
|
╭────────────── Caption ───────────────╮
|
|
|
|
|
│ Variable Modified value │
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 HTTP Proxy
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
#### Output in read write mode
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
|
|
|
|
<span style="color: #ffff00">┗━━ </span>variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/04/config.yaml"
|
|
|
|
|
╭────────────── Caption ───────────────╮
|
|
|
|
|
│ Variable Modified value │
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 HTTP Proxy
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP address: example.net ◀ loaded from the YAML file "config/04/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 5
|
|
|
|
|
|
|
|
|
|
#### config/05/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```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
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
|
|
|
|
<span style="color: #ffff00">┣━━ </span>variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
|
|
|
|
|
<span style="color: #ffff00">┣━━ </span>variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
|
|
|
|
|
<span style="color: #ffff00">┗━━ </span>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 │
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 HTTP Proxy
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
#### Output in read write mode
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_020
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
|
|
|
|
<span style="color: #ffff00">┣━━ </span>variable or family "manual.http_proxy.port" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
|
|
|
|
|
<span style="color: #ffff00">┣━━ </span>variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
|
|
|
|
|
<span style="color: #ffff00">┗━━ </span>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 │
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 HTTP Proxy
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- [[tutorial v1.1_021] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021))
|
|
|
|
|
- [[tutorial v1.1_022] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
|
|
|
|
|
|