2025-11-10 08:21:12 +01:00
- [Summary ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md )
2025-11-10 08:21:53 +01:00
- [[tutorial v1.1_104] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_104/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_104~1..v1.1_104))
2025-11-10 08:21:12 +01:00
2025-11-10 08:21:53 +01:00
# [tutorial v1.1_105)] xxx
2025-11-10 08:21:12 +01:00
2025-11-10 08:21:53 +01:00
[View the diff ](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_105~1..v1.1_105 )
2025-11-10 08:21:12 +01:00
2025-11-10 08:21:50 +01:00
[Read the documentation ](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx )
2025-11-10 08:21:12 +01:00
2025-11-10 08:21:11 +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-10 08:21:53 +01:00
git switch --detach v1.1_105
2025-11-10 08:21:11 +01:00
```
2025-11-10 08:21:12 +01:00
## Structure
< p >
2025-11-10 08:21:53 +01:00
< a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/./" > .< / a > < br / >
├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/./firefox/" > firefox< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/./firefox/00-proxy.yml" > 00-proxy.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/./firefox/10-manual.yml" > 10-manual.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/./firefox/20-manual.yml" > 20-manual.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/./firefox/30-auto.yml" > 30-auto.yml< / a > < br / >
│ ├── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/./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_105/./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_105/./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_105/./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_105/./firefox/empty.yml" > empty.yml< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/./foxyproxy/" > foxyproxy< / a > < br / >
└── < a href = "https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/./foxyproxy/00-foxyproxy.yml" > 00-foxyproxy.yml< / a > < br / >
2025-11-10 08:21:12 +01:00
< br / > < br / > < / p >
2025-11-10 08:21:50 +01:00
Contents of the foxyproxy/00-foxyproxy.yml file
2025-11-10 08:21:12 +01:00
```yml
%YAML 1.2
---
version: 1.1
2025-11-10 08:21:50 +01:00
proxies:
description: Proxy configuration
2025-11-10 08:21:52 +01:00
_type: leadership
2025-11-10 08:21:50 +01:00
title:
description: Title or Description
mandatory: false
2025-11-10 08:21:52 +01:00
type:
description: Proxy Type
choices:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5
- PAC URL
- WPAD
- System (use system settings)
- Direct (no proxy)
default: Direct (no proxy)
2025-11-10 08:21:51 +01:00
color:
description: Color
regexp: ^#(?:[0-9a-f]{3}){1,2}$
default:
jinja: >-
#
{%- for i in range(6) -%}
{{- '0123456789abcdef' | random -}}
{%- endfor -%}
description: random color value
auto_save: true
2025-11-10 08:21:53 +01:00
address:
description: IP address, DNS name, server name
type: domainname
params:
allow_ip: true
allow_without_dot: true
default:
jinja: >-
{% if firefox.manual.http_proxy.address is not propertyerror %}
{{ firefox.manual.http_proxy.address }}
{% endif %}
description: copy HTTP address if proxy is not "Manual"
disabled:
jinja: |-
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
disabled
{% endif %}
description: |-
if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5
port:
description: Port
type: port
default:
jinja: >-
{% if firefox.manual.http_proxy.port is not propertyerror %}
{{ firefox.manual.http_proxy.port }}
{% endif %}
description: copy HTTP port if proxy is not "Manual"
disabled:
jinja: |-
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
disabled
{% endif %}
description: |-
if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5
username:
description: Username
type: unix_user
mandatory:
jinja: |-
{% if _.password is not propertyerror and _ .password %}
username is mandatory
{% endif %}
description: if a password is set
disabled:
jinja: |-
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
disabled
{% endif %}
description: |-
if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5
password:
description: Password
type: secret
mandatory: false
disabled:
jinja: |-
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
disabled
{% endif %}
description: |-
if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5
url:
description: URL
type: web_address
default:
jinja: >-
{% if firefox.auto is not propertyerror %}
{{ firefox.auto }}
{% endif %}
description: copy HTTP address if proxy is "Auto"
disabled:
jinja: |-
{% if _.type not in ['PAC URL', 'WPAD'] %}
proxy does not need url
{% endif %}
description: |-
if type is not in:
- PAC URL
- WPAD
2025-11-10 08:21:12 +01:00
...
```
2025-11-10 08:21:13 +01:00
### Let's generate the documentation
```shell
2025-11-10 08:21:50 +01:00
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc
2025-11-10 08:21:13 +01:00
```
2025-11-10 08:21:50 +01:00
#### Variables for "Firefox"
**firefox**
`basic`
2025-11-10 08:21:43 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-10 08:21:50 +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-10 08:21:13 +01:00
2025-11-10 08:21:50 +01:00
##### Manual proxy configuration
2025-11-10 08:21:24 +01:00
| Informations |
|:------------|
2025-11-10 08:21:50 +01:00
| **firefox.manual** < br > `basic` *`disabled`* < br > **Disabled**: when the variable "firefox.proxy_mode" hasn't the value "Manual proxy configuration" |
2025-11-10 08:21:24 +01:00
2025-11-10 08:21:50 +01:00
###### HTTP Proxy
2025-11-10 08:21:24 +01:00
| Informations |
|:------------|
2025-11-10 08:21:50 +01:00
| **firefox.manual.http_proxy** < br > `basic` |
2025-11-10 08:21:24 +01:00
2025-11-10 08:21:43 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-10 08:21:50 +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-10 08:21:24 +01:00
2025-11-10 08:21:43 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-10 08:21:50 +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-10 08:21:24 +01:00
2025-11-10 08:21:50 +01:00
###### *HTTPS* Proxy or *SOCKS* Proxy
2025-11-10 08:21:25 +01:00
| Informations |
|:------------|
2025-11-10 08:21:50 +01:00
| **firefox.manual.*https*_proxy** < br /> **firefox.manual.*socks*_proxy**< br > This family builds families dynamically< br > `standard` *`hidden`* < br > **Hidden**: in HTTPS case if "_.use_for_https" is set to "true"< br > **Identifiers**: < br /> - HTTPS< br /> - SOCKS |
2025-11-10 08:21:25 +01:00
2025-11-10 08:21:43 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-10 08:21:50 +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" |
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **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"< br /> or "firefox.manual.socks_proxy.version" is "v4" |
##### DNS over HTTPS
| Informations |
|:------------|
| **firefox.dns_over_https** < br > `basic` |
2025-11-10 08:21:27 +01:00
2025-11-10 08:21:43 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-10 08:21:50 +01:00
| **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**
2025-11-10 08:21:26 +01:00
2025-11-10 08:21:50 +01:00
`basic`
##### Proxy configuration
2025-11-10 08:21:44 +01:00
| Informations |
|:------------|
2025-11-10 08:21:50 +01:00
| **foxyproxy.proxies** < br > This family contains lists of variable blocks< br > `basic` |
2025-11-10 08:21:44 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2025-11-10 08:21:50 +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-10 08:21:52 +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-10 08:21:51 +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-10 08:21:53 +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:< br /> - HTTP< br /> - HTTPS/SSL< br /> - SOCKS4< br /> - 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:< br /> - HTTP< br /> - HTTPS/SSL< br /> - SOCKS4< br /> - SOCKS5 |
| **foxyproxy.proxies.username** < br /> [`unix_user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* *`disabled`* | Username.< br /> **Mandatory**: if a password is set< br /> **Disabled**: if type not in:< br /> - HTTP< br /> - HTTPS/SSL< br /> - SOCKS4< br /> - SOCKS5 |
| **foxyproxy.proxies.password** < br /> [`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Password.< br /> **Disabled**: if type not in:< br /> - HTTP< br /> - HTTPS/SSL< br /> - SOCKS4< br /> - 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:< br /> - PAC URL< br /> - WPAD |
2025-11-10 08:21:44 +01:00
2025-11-10 08:21:50 +01:00
### Let's generate the changelog
2025-11-10 08:21:33 +01:00
2025-11-10 08:21:50 +01:00
```shell
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc --doc.contents changelog
```
2025-11-10 08:21:53 +01:00
#### New variables
2025-11-10 08:21:52 +01:00
2025-11-10 08:21:53 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **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:< br /> - HTTP< br /> - HTTPS/SSL< br /> - SOCKS4< br /> - 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:< br /> - HTTP< br /> - HTTPS/SSL< br /> - SOCKS4< br /> - SOCKS5 |
| **foxyproxy.proxies.username** < br /> [`unix_user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* *`disabled`* | Username.< br /> **Mandatory**: if a password is set< br /> **Disabled**: if type not in:< br /> - HTTP< br /> - HTTPS/SSL< br /> - SOCKS4< br /> - SOCKS5 |
| **foxyproxy.proxies.password** < br /> [`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Password.< br /> **Disabled**: if type not in:< br /> - HTTP< br /> - HTTPS/SSL< br /> - SOCKS4< br /> - 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:< br /> - PAC URL< br /> - WPAD |
2025-11-10 08:21:52 +01:00
2025-11-10 08:21:51 +01:00
#### Modified variable
2025-11-10 08:21:33 +01:00
2025-11-10 08:21:53 +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 |
2025-11-10 08:21:51 +01:00
2025-11-10 08:21:53 +01:00
- [[tutorial v1.1_110] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110))