212 lines
10 KiB
Markdown
212 lines
10 KiB
Markdown
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||
- [[tutorial v1.1_030] A variable with type "domainname"](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_031)] A variable with type's parameters
|
||
|
||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031)
|
||
|
||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type's-parameters)
|
||
|
||
|
||
## Screenshot
|
||
|
||
|
||
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
||
|
||
|
||
## Clone and install
|
||
|
||
|
||
|
||
To test this tutorial, you need to download this repository and install Rougail:
|
||
|
||
```shell
|
||
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
|
||
cd rougail-tutorials
|
||
python -m venv venv_rougail
|
||
. venv_rougail/bin/activate
|
||
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
|
||
```
|
||
|
||
Then switch to the tutorial page:
|
||
|
||
```shell
|
||
git switch --detach v1.1_031
|
||
```
|
||
|
||
## Structure
|
||
|
||
|
||
|
||
<p>
|
||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/./">.</a><br/>
|
||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/./firefox/">firefox</a><br/>
|
||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||
<br/><br/></p>
|
||
|
||
Contents of the firefox/10-manual.yml file
|
||
|
||
```yml
|
||
%YAML 1.2
|
||
---
|
||
version: 1.1
|
||
|
||
manual: # Manual proxy configuration
|
||
|
||
http_proxy: # HTTP Proxy
|
||
|
||
address:
|
||
description: HTTP address
|
||
type: domainname
|
||
params:
|
||
allow_ip: true
|
||
...
|
||
|
||
```
|
||
### Let's generate the documentation
|
||
|
||
```shell
|
||
rougail -m firefox/ -o doc
|
||
```
|
||
| Variable | Description |
|
||
|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>• No proxy **← (default)**<br/>• Auto-detect proxy settings for this network<br/>• Use system proxy settings<br/>• Manual proxy configuration<br/>• Automatic proxy configuration URL |
|
||
|
||
#### Manual proxy configuration
|
||
|
||
> **🛈 Informations**
|
||
>
|
||
> **<a id="manual" name="manual">manual</a>**
|
||
|
||
##### HTTP Proxy
|
||
|
||
> **🛈 Informations**
|
||
>
|
||
> **<a id="manual.http_proxy" name="manual.http_proxy">manual.http_proxy</a>**
|
||
|
||
| Variable | Description |
|
||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
|
||
| **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
|
||
|
||
### Let's generate the changelog
|
||
|
||
```shell
|
||
rougail -m firefox/ -o doc --doc.contents changelog
|
||
```
|
||
#### Modified variable
|
||
|
||
| Variable | Description |
|
||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
|
||
| **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validators**: <br/>• type domainname<br/>• <ins>the domain name can be an IP</ins> |
|
||
|
||
|
||
## User datas
|
||
|
||
### Example 1
|
||
|
||
#### config/01/config.yml
|
||
|
||
|
||
```yml
|
||
---
|
||
manual:
|
||
http_proxy:
|
||
address: example.net
|
||
```
|
||
#### Output
|
||
|
||
```shell
|
||
rougail -m firefox/ -u yaml -yf config/01/config.yml
|
||
```
|
||
<pre>╭──────── Caption ────────╮
|
||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||
│ <span style="color: #00aa00">Modified value</span> │
|
||
╰─────────────────────────╯
|
||
Variables:
|
||
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">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: <span style="color: #00aa00">example.net</span> ◀ loaded from the YAML file "config/01/config.yml"
|
||
</pre>
|
||
### Example 2
|
||
|
||
#### config/02/config.yml
|
||
|
||
|
||
```yml
|
||
---
|
||
manual:
|
||
http_proxy:
|
||
address: 192.168.0.1
|
||
```
|
||
#### Output
|
||
|
||
```shell
|
||
rougail -m firefox/ -u yaml -yf config/02/config.yml
|
||
```
|
||
<pre>╭──────── Caption ────────╮
|
||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||
│ <span style="color: #00aa00">Modified value</span> │
|
||
╰─────────────────────────╯
|
||
Variables:
|
||
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">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: <span style="color: #00aa00">192.168.0.1</span> ◀ loaded from the YAML file "config/02/config.yml"
|
||
</pre>
|
||
#### Output when invalid user datas is an error
|
||
|
||
```shell
|
||
rougail -m firefox/ -u yaml -yf config/02/config.yml --cli.invalid_user_datas_error
|
||
```
|
||
<pre>╭──────── Caption ────────╮
|
||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||
│ <span style="color: #00aa00">Modified value</span> │
|
||
╰─────────────────────────╯
|
||
Variables:
|
||
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">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: <span style="color: #00aa00">192.168.0.1</span> ◀ loaded from the YAML file "config/02/config.yml"
|
||
</pre>
|
||
### Example 3
|
||
|
||
#### config/03/config.yml
|
||
|
||
|
||
```yml
|
||
---
|
||
manual:
|
||
http_proxy:
|
||
address: not a valid domain name
|
||
```
|
||
#### Output
|
||
|
||
```shell
|
||
rougail -m firefox/ -u yaml -yf config/03/config.yml
|
||
```
|
||
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||
<span style="color: #ffff00">┗━━ </span>the value "not a valid domain name" is an invalid domain name for "manual.http_proxy.address" (HTTP address), must
|
||
<span style="color: #ffff00"> </span>have dot, it will be ignored when loading from the YAML file "config/03/config.yml"
|
||
╭─────── Caption ────────╮
|
||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||
╰────────────────────────╯
|
||
Variables:
|
||
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">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: <span style="color: #ffd700">null</span>
|
||
</pre>
|
||
#### Output when invalid user datas is an error
|
||
|
||
```shell
|
||
rougail -m firefox/ -u yaml -yf config/03/config.yml --cli.invalid_user_datas_error
|
||
```
|
||
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
||
<span style="color: #ff0000">┗━━ </span>the value "not a valid domain name" is an invalid domain name for "manual.http_proxy.address" (HTTP address), must
|
||
<span style="color: #ff0000"> </span>have dot, it will be ignored when loading from the YAML file "config/03/config.yml"
|
||
</pre>
|
||
|
||
|
||
- [[tutorial v1.1_032] A variable with type "port"](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))
|