2025-11-22 14:13:21 +01:00
- [Summary ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md )
2025-11-22 14:14:23 +01:00
- [[tutorial v1.1_114] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_114~1..v1.1_114))
2025-11-22 14:13:21 +01:00
2025-11-22 14:14:23 +01:00
# [tutorial v1.1_120)] xxx
2025-11-22 14:13:21 +01:00
2025-11-22 14:14:23 +01:00
[View the diff ](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_120~1..v1.1_120 )
2025-11-22 14:13:21 +01:00
2025-11-22 14:14:16 +01:00
[Read the documentation ](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx )
2025-11-22 14:13:21 +01:00
2025-11-22 14:13:19 +01:00
## 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
2025-11-22 14:14:23 +01:00
git switch --detach v1.1_120
2025-11-22 14:13:19 +01:00
```
2025-11-22 14:13:21 +01:00
## Structure
< p >
2025-11-22 14:14:23 +01:00
< a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./" > .< / a > < br / >
├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/" > firefox< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/00-proxy.yml" > 00-proxy.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/10-manual.yml" > 10-manual.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/20-manual.yml" > 20-manual.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/30-auto.yml" > 30-auto.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/40-no_proxy.yml" > 40-no_proxy.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/50-prompt_authentication.yml" > 50-prompt_authentication.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/55-proxy_dns_socks5.yml" > 55-proxy_dns_socks5.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/60-dns_over_https.yml" > 60-dns_over_https.yml< / a > < br / >
│ └── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/empty.yml" > empty.yml< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./foxyproxy/" > foxyproxy< / a > < br / >
├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./foxyproxy/00-foxyproxy.yml" > 00-foxyproxy.yml< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./foxyproxy/10-redefine.yml" > 10-redefine.yml< / a > < br / >
2025-11-22 14:13:21 +01:00
< br / > < br / > < / p >
2025-11-22 14:14:23 +01:00
Contents of the foxyproxy/10-redefine.yml file
2025-11-22 14:13:21 +01:00
```yml
%YAML 1.2
---
version: 1.1
2025-11-22 14:14:16 +01:00
proxies:
2025-11-22 14:14:21 +01:00
username:
2025-11-22 14:14:23 +01:00
redefine: true
mandatory: false
2025-11-22 14:14:21 +01:00
password:
2025-11-22 14:14:23 +01:00
redefine: true
hidden:
2025-11-22 14:14:21 +01:00
jinja: |-
2025-11-22 14:14:23 +01:00
{% if not _.username %}
no username defined
2025-11-22 14:14:21 +01:00
{% endif %}
2025-11-22 14:14:23 +01:00
description: if username is not defined
2025-11-22 14:13:21 +01:00
...
```
2025-11-22 14:13:22 +01:00
### Let's generate the documentation
```shell
2025-11-22 14:14:16 +01:00
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc
2025-11-22 14:13:22 +01:00
```
2025-11-22 14:14:16 +01:00
#### Variables for "Firefox"
**firefox**
`basic`
2025-11-22 14:14:06 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-22 14:14:16 +01:00
| **firefox.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 |
2025-11-22 14:13:22 +01:00
2025-11-22 14:14:16 +01:00
##### Manual proxy configuration
2025-11-22 14:13:39 +01:00
2025-11-22 14:14:16 +01:00
**firefox.manual**
2025-11-22 14:13:39 +01:00
2025-11-22 14:14:06 +01:00
`basic` *`disabled`*
2025-11-22 14:13:39 +01:00
2025-11-22 14:14:16 +01:00
**Disabled**: when the variable "firefox.proxy_mode" hasn't the value "Manual proxy configuration"
2025-11-22 14:13:39 +01:00
2025-11-22 14:14:16 +01:00
###### HTTP Proxy
2025-11-22 14:13:39 +01:00
2025-11-22 14:14:16 +01:00
**firefox.manual.http_proxy**
2025-11-22 14:13:39 +01:00
2025-11-22 14:14:06 +01:00
`basic`
2025-11-22 14:13:39 +01:00
2025-11-22 14:14:06 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-22 14:14:16 +01:00
| **firefox.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 |
| **firefox.manual.http_proxy.port** < br /> [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTP Port.< br /> **Validators**: < br /> - well-known ports (1 to 1023) are allowed< br /> - registred ports (1024 to 49151) are allowed< br /> - private ports (greater than 49152) are allowed< br /> **Default**: 8080 |
2025-11-22 14:13:39 +01:00
2025-11-22 14:14:06 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-22 14:14:16 +01:00
| **firefox.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 |
2025-11-22 14:13:39 +01:00
2025-11-22 14:14:16 +01:00
###### *HTTPS* Proxy or *SOCKS* Proxy
2025-11-22 14:13:40 +01:00
2025-11-22 14:13:44 +01:00
This family builds families dynamically
2025-11-22 14:14:16 +01:00
**firefox.manual.*https*_proxy**< br / > **firefox.manual.*socks*_proxy**
2025-11-22 14:13:40 +01:00
2025-11-22 14:14:06 +01:00
`standard` *`hidden`*
2025-11-22 14:13:40 +01:00
2025-11-22 14:13:48 +01:00
**Hidden**: in HTTPS case if "_.use_for_https" is set to "true"
2025-11-22 14:13:40 +01:00
2025-11-22 14:13:44 +01:00
**Identifiers**: < br / > - HTTPS< br / > - SOCKS
2025-11-22 14:14:06 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-22 14:14:16 +01:00
| **firefox.manual.*https*_proxy.address** < br /> **firefox.manual.*socks*_proxy.address**< br /> [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | *HTTPS* or *SOCKS* address.< br /> **Validator**: the domain name can be an IP< br /> **Default**: the value of the variable "firefox.manual.http_proxy.address" |
| **firefox.manual.*https*_proxy.port** < br /> **firefox.manual.*socks*_proxy.port**< br /> [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | *HTTPS* or *SOCKS* port.< br /> **Validators**: < br /> - well-known ports (1 to 1023) are allowed< br /> - registred ports (1024 to 49151) are allowed< br /> - private ports (greater than 49152) are allowed< br /> **Default**: the value of the variable "firefox.manual.http_proxy.port" |
| **firefox.manual.*https*_proxy.version** < br /> **firefox.manual.*socks*_proxy.version**< br /> [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | SOCKS host version used by proxy.< br /> **Choices**: < br /> - v4< br /> - v5 ** ← (default)**< br /> **Disabled**: when the identifier is "HTTPS" |
2025-11-22 14:13:43 +01:00
2025-11-22 14:14:06 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-22 14:14:16 +01:00
| **firefox.auto** < br /> [`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Automatic proxy configuration URL.< br /> **Validator**: the domain name in web address can be only a hostname< br /> **Disabled**: when the variable "firefox.proxy_mode" hasn't the value "Automatic proxy configuration URL" |
| **firefox.no_proxy** < br /> [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.< br /> Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.< br /> **Validators**: < br /> - the domain name can starts by a dot< br /> - the domain name can be a hostname< br /> - the domain name can be an IP< br /> - the domain name can be network in CIDR format< br /> **Examples**: < br /> - .mozilla.org< br /> - .net.nz< br /> - 192.168.1.0/24< br /> **Disabled**: when the variable "firefox.proxy_mode" has the value "No proxy" |
| **firefox.prompt_authentication** < br /> [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Prompt for authentication if password is saved.< br /> **Default**: true< br /> **Disabled**: when the variable "firefox.proxy_mode" has the value "No proxy" |
| **firefox.proxy_dns_socks5** < br /> [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.< br /> **Default**: false< br /> **Disabled**: if "firefox.proxy_mode" is not "Manual proxy configuration"
2025-11-22 14:14:06 +01:00
or "firefox.manual.socks_proxy.version" is "v4" |
2025-11-22 14:13:41 +01:00
2025-11-22 14:14:16 +01:00
##### DNS over HTTPS
**firefox.dns_over_https**
`basic`
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **firefox.dns_over_https.enable_dns_over_https** < br /> [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.< br /> **Default**: false |
| **firefox.dns_over_https.provider** < br /> [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Use Provider.< br /> **Choices**: < br /> - Cloudflare ** ← (default)**< br /> - NextDNS< br /> - Custom< br /> **Disabled**: when the variable "firefox.dns_over_https.enable_dns_over_https" has the value "false" |
| **firefox.dns_over_https.custom_dns_url** < br /> [`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS URL.< br /> **Validators**: < br /> - the domain name in web address can be only a hostname< br /> - must starts with 'https://' only< br /> **Disabled**: if "_.provider" is not "Custom" |
#### Variables for "FoxyProxy"
**foxyproxy**
`basic`
##### Proxy configuration
2025-11-22 14:14:08 +01:00
2025-11-22 14:14:16 +01:00
This family contains lists of variable blocks
**foxyproxy.proxies**
2025-11-22 14:14:08 +01:00
2025-11-22 14:14:11 +01:00
`basic`
2025-11-22 14:14:08 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-22 14:14:16 +01:00
| **foxyproxy.proxies.title** < br /> [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | Title or Description. |
2025-11-22 14:14:20 +01:00
| **foxyproxy.proxies.type** < br /> [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.< br /> **Choices**: < br /> - HTTP< br /> - HTTPS/SSL< br /> - SOCKS4< br /> - SOCKS5< br /> - PAC URL< br /> - WPAD< br /> - System (use system settings)< br /> - Direct (no proxy) ** ← (default)** |
2025-11-22 14:14:18 +01:00
| **foxyproxy.proxies.color** < br /> [`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.< br /> **Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"< br /> **Default**: random color value |
2025-11-22 14:14:21 +01:00
| **foxyproxy.proxies.address** < br /> [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.< br /> **Validators**: < br /> - the domain name can be a hostname< br /> - the domain name can be an IP< br /> **Default**: copy HTTP address if proxy is not "Manual"< br /> **Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 |
| **foxyproxy.proxies.port** < br /> [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.< br /> **Validators**: < br /> - well-known ports (1 to 1023) are allowed< br /> - registred ports (1024 to 49151) are allowed< br /> - private ports (greater than 49152) are allowed< br /> **Default**: copy HTTP port if proxy is not "Manual"< br /> **Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 |
2025-11-22 14:14:23 +01:00
| **foxyproxy.proxies.username** < br /> [`unix_user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Username.< br /> **Disabled**: if type not in:
2025-11-22 14:14:21 +01:00
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 |
2025-11-22 14:14:23 +01:00
| **foxyproxy.proxies.password** < br /> [`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* *`disabled`* | Password.< br /> **Hidden**: if username is not defined< br /> **Disabled**: if type not in:
2025-11-22 14:14:21 +01:00
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5 |
| **foxyproxy.proxies.url** < br /> [`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.< br /> **Validator**: the domain name in web address can be only a hostname< br /> **Default**: copy HTTP address if proxy is "Auto"< br /> **Disabled**: if type is not in:
- PAC URL
- WPAD |
2025-11-22 14:14:16 +01:00
### Let's generate the changelog
```shell
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc --doc.contents changelog
```
2025-11-22 14:14:23 +01:00
#### Modified variables
2025-11-22 14:14:21 +01:00
2025-11-22 14:14:23 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **foxyproxy.proxies.color** < br /> [`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.< br /> **Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"< br /> **Default**: random color value |
| **foxyproxy.proxies.username** < br /> ~~`mandatory`~~ [`unix_user` ](https://rougail.readthedocs.io/en/latest/variable.html#variables-types ) `standard` *`disabled`* | Username.< br /> **Mandatory**: ~~if a password is set~~ < br /> **Disabled**: if type not in:
2025-11-22 14:14:21 +01:00
- HTTP
- HTTPS/SSL
- SOCKS4
2025-11-22 14:14:23 +01:00
- SOCKS5 |
| **foxyproxy.proxies.password** < br /> [`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` < ins > *`hidden`*</ ins > *`disabled`* | Password.< br /> **Hidden**: < ins > if username is not defined</ ins >< br /> **Disabled**: if type not in:
2025-11-22 14:14:21 +01:00
- HTTP
- HTTPS/SSL
- SOCKS4
2025-11-22 14:14:23 +01:00
- SOCKS5 |
2025-11-22 14:14:16 +01:00