- [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"
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_025~1..v1.1_025)
## Screenshot
## Structure
### firefox/00-proxy.yml
```yml
%YAML 1.2
---
version: 1.1
proxy_mode:
description: Configure Proxy Access to the Internet
choices:
- No proxy
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL
default: No proxy
...
```
### firefox/10-manual.yml
```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
port:
description: HTTP Port
type: port
default: 8080
...
```
### Let's generate the documentation
```console
foo@bar:~$ git switch --detach v1.1_025
foo@bar:~$ rougail -m firefox/ -o doc -do github
```
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy_mode**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
- No proxy **← (default)**
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL |
#### Manual proxy configuration
**manual**
##### HTTP Proxy
**manual.http_proxy**
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **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 |
### Let's generate the changelog
```console
foo@bar:~$ git switch --detach v1.1_025
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
```
#### 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 |
## User datas
### Example 1
#### config/01/config.yaml
```yml
---
```
#### Output
```console
foo@bar:~$ git switch --detach v1.1_025
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
```
🛑 ERRORS ┗━━ The following variables are mandatory but have no value: ┗━━ Manual proxy configuration ┗━━ 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 ```yml --- proxy_mode: Manual proxy configuration ``` #### Output ```console foo@bar:~$ git switch --detach v1.1_025 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml ```
🛑 ERRORS ┗━━ The following variables are mandatory but have no value: ┗━━ Manual proxy configuration ┗━━ 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 ```yml --- proxy_mode: Manual proxy configuration manual: http_proxy: address: example.net ``` #### Output ```console foo@bar:~$ git switch --detach v1.1_025 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### 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_025 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)### 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_025 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)- [[tutorial v1.1_026] A disabled family](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))