2024-11-02 14:58:10 +01:00
- [Summary ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md )
2024-11-02 14:58:19 +01:00
- [[tutorial 022] A variable inside sub family](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))
2024-11-02 14:58:10 +01:00
2024-11-02 14:58:19 +01:00
# [tutorial 023] Family type is optional
2024-11-02 14:58:10 +01:00
2024-11-02 14:58:19 +01:00
[View the diff ](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023 )
2024-11-02 14:58:10 +01:00
2024-11-02 14:58:09 +01:00
## Screenshot
< img src = "firefox.png" width = 50% height = 50% alt = "Firefox Proxy setting" / >
## Structure
2024-11-02 14:58:10 +01:00
### firefox/00-proxy.yml
```yml
---
2024-11-02 14:58:12 +01:00
proxy_mode:
2024-11-02 14:58:13 +01:00
description: Configure Proxy Access to the Internet
2024-11-02 14:58:14 +01:00
choices:
- No proxy
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL
2024-11-02 14:58:13 +01:00
default: No proxy
2024-11-02 14:58:10 +01:00
```
2024-11-02 14:58:16 +01:00
### firefox/10-manual.yml
2024-11-02 14:58:12 +01:00
```yml
---
2024-11-02 14:58:16 +01:00
manual:
description: Manual proxy configuration
2024-11-02 14:58:12 +01:00
2024-11-02 14:58:17 +01:00
http_proxy:
description: HTTP Proxy
2024-11-02 14:58:18 +01:00
address:
description: HTTP address
2024-11-02 14:58:12 +01:00
```
2024-11-02 14:58:16 +01:00
### Generated documentation
2024-11-02 14:58:12 +01:00
```console
2024-11-02 14:58:16 +01:00
foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
2024-11-02 14:58:12 +01:00
```
2024-11-02 14:58:16 +01:00
### Variables
2024-11-02 14:58:12 +01:00
2024-11-02 14:58:18 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy_mode** < 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
##### HTTP Proxy
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.http_proxy.address** < br /> [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address. |
## User data
### Example 1
#### config/01/config.yaml
```yml
---
```
#### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml
```
< pre > 🛑 ERRORS
< span style = "color: #ff0000 " > ┣━━ </ span > The following variables are mandatory but have no value:
< span style = "color: #ff0000 " > ┗━━ </ span > - manual.http_proxy.address (HTTP address)
< / pre >
### Example 2
#### config/02/config.yaml
```yml
---
2024-11-02 14:58:19 +01:00
proxy_mode: No proxy
2024-11-02 14:58:18 +01:00
```
#### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml
```
< pre > 🛑 ERRORS
< span style = "color: #ff0000 " > ┣━━ </ span > The following variables are mandatory but have no value:
< span style = "color: #ff0000 " > ┗━━ </ span > - manual.http_proxy.address (HTTP address)
< / pre >
### Example 3
#### config/03/config.yaml
```yml
---
proxy_mode: Manual proxy configuration
```
#### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml
```
2024-11-02 14:58:19 +01:00
< pre > 🛑 ERRORS
< span style = "color: #ff0000 " > ┣━━ </ span > The following variables are mandatory but have no value:
< span style = "color: #ff0000 " > ┗━━ </ span > - manual.http_proxy.address (HTTP address)
2024-11-02 14:58:18 +01:00
< / pre >
### Example 4
#### config/04/config.yaml
```yml
---
2024-11-02 14:58:19 +01:00
proxy_mode: foo
2024-11-02 14:58:18 +01:00
```
#### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml
```
< pre > 🛑 ERRORS
2024-11-02 14:58:19 +01:00
< span style = "color: #ff0000 " > ┣━━ </ span > "foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only
< span style = "color: #ff0000 " > ┃ </ span > "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
< span style = "color: #ff0000 " > ┃ </ span > configuration", "No proxy" and "Use system proxy settings" are allowed
< span style = "color: #ff0000 " > ┣━━ </ span > The following variables are mandatory but have no value:
< span style = "color: #ff0000 " > ┗━━ </ span > - manual.http_proxy.address (HTTP address)
2024-11-02 14:58:18 +01:00
< / pre >
### Example 5
#### config/05/config.yaml
2024-11-02 14:58:12 +01:00
2024-11-02 14:58:18 +01:00
```yml
---
2024-11-02 14:58:19 +01:00
proxy_mode: 1
2024-11-02 14:58:18 +01:00
```
#### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
```
< pre > 🛑 ERRORS
2024-11-02 14:58:19 +01:00
< span style = "color: #ff0000 " > ┣━━ </ span > "1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
< span style = "color: #ff0000 " > ┃ </ span > proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration",
< span style = "color: #ff0000 " > ┃ </ span > "No proxy" and "Use system proxy settings" are allowed
< span style = "color: #ff0000 " > ┣━━ </ span > The following variables are mandatory but have no value:
< span style = "color: #ff0000 " > ┗━━ </ span > - manual.http_proxy.address (HTTP address)
2024-11-02 14:58:18 +01:00
< / pre >
2024-11-02 14:58:12 +01:00
2024-11-02 14:58:19 +01:00
- [[tutorial 024] A variable with type "domainname"](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))