2024-09-07 19:06:25 +02:00
---
gitea: none
include_toc: true
---
# Summary
2024-09-07 19:06:26 +02:00
- [[tutorial 001] An empty file](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001))
2024-09-07 19:06:27 +02:00
- [[tutorial 002] A first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002))
2024-09-07 19:06:28 +02:00
- [[tutorial 003] A first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003))
2024-09-07 19:06:29 +02:00
- [[tutorial 004] The variable description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_004/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_004~1..v1.1_004))
2024-09-07 19:06:30 +02:00
- [[tutorial 005] A default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_005/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_005~1..v1.1_005))
2024-09-07 19:06:31 +02:00
- [[tutorial 006] A variable with type choice](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_006/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_006~1..v1.1_006))
2024-09-07 19:06:32 +02:00
- [[tutorial 007] Choice type is optional](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_007/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_007~1..v1.1_007))
2024-09-07 19:06:32 +02:00
- [[tutorial 010] A family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010))
2024-09-07 19:06:33 +02:00
- [[tutorial 011] Conditional desactived family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_011/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011))
2024-09-07 19:06:34 +02:00
- [[tutorial 012] Conditional desactived 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))
2024-09-07 19:06:35 +02:00
- [[tutorial 013] A sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_013/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_013~1..v1.1_013))
2024-09-07 19:06:36 +02:00
- [[tutorial 014] Family in "shorthand" mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_014/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_014~1..v1.1_014))
2024-09-07 19:06:37 +02:00
- [[tutorial 015] Family in "shorthand" mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_015/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_015~1..v1.1_015))
2024-09-07 19:06:38 +02:00
- [[tutorial 016] Family in "shorthand" mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_016/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_016~1..v1.1_016))
2024-09-07 19:06:39 +02:00
- [[tutorial 017] Family in "shorthand" mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_017/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_017~1..v1.1_017))
2024-09-07 19:06:40 +02:00
- [[tutorial 018] Family in "shorthand" mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_018/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_018~1..v1.1_018))
2024-09-07 19:06:42 +02:00
- [[tutorial 020] A boolean variable](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))
2024-09-07 19:06:43 +02:00
- [[tutorial 021] Bases type is optional if default value](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))
2024-09-07 19:06:25 +02:00
# Description
< img src = "firefox.png" width = 50% height = 50% alt = "Firefox Proxy setting" / >
2024-09-07 19:06:43 +02:00
Bases type is optional if default value
2024-09-07 19:06:27 +02:00
2024-09-07 19:06:43 +02:00
The type is deduct with the default value type. This is only true for "string", "number", "float" or "boolean" variables.
2024-09-07 19:06:25 +02:00
# Structure
2024-09-07 19:06:26 +02:00
## firefox/00-proxy.yml
```yml
---
2024-09-07 19:06:28 +02:00
proxy_mode:
2024-09-07 19:06:29 +02:00
description: Configure Proxy Access to the Internet
2024-09-07 19:06:31 +02:00
choices:
- No proxy
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL
2024-09-07 19:06:30 +02:00
default: No proxy
2024-09-07 19:06:26 +02:00
2024-09-07 19:06:32 +02:00
```
## firefox/10-manual.yml
```yml
---
manual:
description: Manual proxy configuration
2024-09-07 19:06:33 +02:00
disabled:
2024-09-07 19:06:38 +02:00
variable: _.proxy_mode
2024-09-07 19:06:33 +02:00
when_not: 'Manual proxy configuration'
2024-09-07 19:06:32 +02:00
2024-09-07 19:06:40 +02:00
http_proxy: # HTTP Proxy
2024-09-07 19:06:35 +02:00
2024-09-07 19:06:36 +02:00
address:
description: HTTP address
type: domainname
params:
allow_ip: true
2024-09-07 19:06:37 +02:00
port:
description: HTTP Port
type: port
default: 8080
2024-09-07 19:06:42 +02:00
```
## firefox/20-manual.yml
```yml
---
manual:
use_for_https:
description: Also use this proxy for HTTPS
default: true
2024-09-07 19:06:26 +02:00
```
## Generated documentation
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
```
2024-09-07 19:06:28 +02:00
### Variables
2024-09-07 19:06:42 +02:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy_mode** < br /> [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `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 |
2024-09-07 19:06:36 +02:00
#### Manual proxy configuration
`basic` _`disabled`_
2024-09-07 19:06:38 +02:00
**Disabled**: when the variable "proxy_mode" hasn't the value "Manual proxy configuration".
2024-09-07 19:06:36 +02:00
##### HTTP Proxy
`basic`
2024-09-07 19:06:42 +02:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.http_proxy.address** < br /> [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP address.< br /> **Validator**: the domain name can be an IP |
| **manual.http_proxy.port** < br /> [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTP Port.< br /> **Default**: 8080 |
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.use_for_https** < br /> [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Also use this proxy for HTTPS.< br /> **Default**: True |
2024-09-07 19:06:28 +02:00
# 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
```
2024-09-07 19:06:30 +02:00
< pre > ╭────────────────────────── Caption ──────────────────────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
│ < span style = "color: #ffaf00 " > Unmodifiable variable</ span > │
╰─────────────────────────────────────────────────────────────╯
Variables:
< span style = "color: #5c5cff " > ┗━━ </ span > 📓 proxy_mode: < span style = "color: #ffd700 " > No proxy</ span >
2024-09-07 19:06:28 +02:00
< / pre >
## Example 2
### config/02/config.yaml
```yml
---
2024-09-07 19:06:32 +02:00
proxy_mode: Manual proxy configuration
2024-09-07 19:06:28 +02:00
```
### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/02/config.yaml
```
2024-09-07 19:06:36 +02: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-09-07 19:06:28 +02:00
< / pre >
## Example 3
### config/03/config.yaml
```yml
---
proxy_mode: Manual proxy configuration
2024-09-07 19:06:32 +02:00
manual:
http_proxy:
address: example.net
2024-09-07 19:06:28 +02:00
```
### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/03/config.yaml
```
2024-09-07 19:06:36 +02:00
< pre > ╭────────────────────────── Caption ──────────────────────────╮
2024-09-07 19:06:28 +02:00
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
│ < span style = "color: #ffaf00 " > Unmodifiable variable</ span > │
╰─────────────────────────────────────────────────────────────╯
Variables:
2024-09-07 19:06:36 +02:00
< span style = "color: #5c5cff " > ┣━━ </ span > 📓 proxy_mode: Manual proxy configuration (< span style = "color: #00aa00 " > No proxy</ span > )
< span style = "color: #5c5cff " > ┗━━ </ span > 📂 manual
2024-09-07 19:06:42 +02:00
< 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 > 📓 address: example.net
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 port: < span style = "color: #ffd700 " > 8080</ span >
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 use_for_https: < span style = "color: #ffd700 " > True</ span >
2024-09-07 19:06:28 +02:00
< / pre >
2024-09-07 19:06:32 +02:00
### Output in read write mode
```console
foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/03/config.yaml --exporter.read_write
```
2024-09-07 19:06:36 +02:00
< pre > ╭────────────────────────── Caption ──────────────────────────╮
2024-09-07 19:06:32 +02:00
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
╰─────────────────────────────────────────────────────────────╯
Variables:
2024-09-07 19:06:36 +02:00
< span style = "color: #5c5cff " > ┣━━ </ span > 📓 proxy_mode: Manual proxy configuration (< span style = "color: #00aa00 " > No proxy</ span > )
< span style = "color: #5c5cff " > ┗━━ </ span > 📂 manual
2024-09-07 19:06:42 +02:00
< 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 > 📓 address: example.net
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 port: < span style = "color: #ffd700 " > 8080</ span >
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 use_for_https: < span style = "color: #ffd700 " > True</ span >
2024-09-07 19:06:32 +02:00
< / pre >
2024-09-07 19:06:28 +02:00
## Example 4
### config/04/config.yaml
```yml
---
2024-09-07 19:06:32 +02:00
proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: example.net
port: '3128'
2024-09-07 19:06:28 +02:00
```
### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/04/config.yaml
```
2024-09-07 19:06:37 +02:00
< pre > ╭────────────────────────── Caption ──────────────────────────╮
2024-09-07 19:06:28 +02:00
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
╰─────────────────────────────────────────────────────────────╯
Variables:
2024-09-07 19:06:36 +02:00
< span style = "color: #5c5cff " > ┣━━ </ span > 📓 proxy_mode: Manual proxy configuration (< span style = "color: #00aa00 " > No proxy</ span > )
< span style = "color: #5c5cff " > ┗━━ </ span > 📂 manual
2024-09-07 19:06:42 +02:00
< 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 > 📓 address: example.net
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 port: 3128 (< span style = "color: #00aa00 " > 8080</ span > )
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 use_for_https: < span style = "color: #ffd700 " > True</ span >
2024-09-07 19:06:28 +02:00
< / pre >
## Example 5
### config/05/config.yaml
```yml
---
2024-09-07 19:06:32 +02:00
proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: http.proxy.net
port: '3128'
use_for_https: false
https_proxy:
address: https.proxy.net
2024-09-07 19:06:28 +02:00
```
### Description
2024-09-07 19:06:32 +02:00
If "use_for_https" is false, HTTPS variables are visible in read only mode and in read write mode.
2024-09-07 19:06:28 +02:00
### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/05/config.yaml
```
< pre > 🛑 ERRORS
2024-09-07 19:06:36 +02:00
< span style = "color: #ff0000 " > ┗━━ </ span > unknown option "https_proxy" in optiondescription "manual (Manual proxy configuration)"
2024-09-07 19:06:30 +02:00
╭────────────────────────── Caption ──────────────────────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
╰─────────────────────────────────────────────────────────────╯
Variables:
2024-09-07 19:06:36 +02:00
< span style = "color: #5c5cff " > ┣━━ </ span > 📓 proxy_mode: Manual proxy configuration (< span style = "color: #00aa00 " > No proxy</ span > )
< span style = "color: #5c5cff " > ┗━━ </ span > 📂 manual
2024-09-07 19:06:42 +02:00
< 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 > 📓 address: http.proxy.net
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 port: 3128 (< span style = "color: #00aa00 " > 8080</ span > )
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 use_for_https: False (< span style = "color: #00aa00 " > True</ span > )
2024-09-07 19:06:28 +02:00
< / pre >