rougail-tutorials/DOCUMENTATION.md

Firefox

Note

This family is a namespace.
Path: firefox
basic

Variable	Description
firefox.proxy_mode choice standard 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

Note

Path: firefox.manual
basic disabled
Disabled: when the variable "Configure Proxy Access to the Internet" hasn't the value "Manual proxy configuration".

HTTP Proxy

Note

Path: firefox.manual.http_proxy
basic

Variable	Description
firefox.manual.http_proxy.address domainname basic mandatory	HTTP proxy address. Validators: • type domainname • the domain name can be an IP
firefox.manual.http_proxy.port port standard mandatory	HTTP proxy 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

Variable	Description
firefox.manual.use_for_https boolean standard mandatory	Also use this proxy for HTTPS. Default: true

HTTPS Proxy

Note

Path: firefox.manual.https_proxy
standard hidden
Hidden: when the variable "Also use this proxy for HTTPS" has the value "true".

Variable	Description
firefox.manual.https_proxy.address domainname standard mandatory	HTTPS proxy address. Validators: • type domainname • the domain name can be an IP Default: the value of the variable "HTTP proxy address".
firefox.manual.https_proxy.port port standard mandatory	HTTPS proxy 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: the value of the variable "HTTP proxy port".

SOCKS Proxy

Note

Path: firefox.manual.socks_proxy
standard

Variable	Description
firefox.manual.socks_proxy.address domainname standard mandatory	SOCKS proxy address. Validators: • type domainname • the domain name can be an IP Default: the value of the variable "HTTP proxy address".
firefox.manual.socks_proxy.port port standard mandatory	SOCKS proxy 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: the value of the variable "HTTP proxy port".
firefox.manual.socks_proxy.version choice standard mandatory	SOCKS host version used by proxy. Choices: • v4 • v5 ← (default)

Variable	Description
firefox.auto web address basic mandatory disabled	Automatic proxy configuration URL. Validators: • well-known ports (1 to 1023) are allowed • registred ports (1024 to 49151) are allowed • type domainname • the domain name can be a hostname Disabled: when the variable "Configure Proxy Access to the Internet" hasn't the value "Automatic proxy configuration URL".
firefox.no_proxy domainname multiple standard disabled unique	Address for which proxy will be desactivated. Connections to localhost, 127.0.0.1/8 and ::1 are never proxied. Validators: • type domainname • the domain name can starts by a dot • the domain name can be a hostname • the domain name can be an IP • the domain name can be network in CIDR format Examples: • .mozilla.org • .net.nz • 192.168.1.0/24 Disabled: when the variable "Configure Proxy Access to the Internet" has the value "No proxy".
firefox.prompt_authentication boolean standard mandatory disabled	Prompt for authentication if password is saved. Default: true Disabled: when the variable "Configure Proxy Access to the Internet" has the value "No proxy".
firefox.proxy_dns_socks5 boolean advanced mandatory disabled	Use proxy DNS when using SOCKS v5. Default: false Disabled: if "Configure Proxy Access to the Internet" is not "Manual proxy configuration" or "SOCKS host version used by proxy" is "v4".

DNS over HTTPS

Note

Path: firefox.dns_over_https
basic

Variable	Description
firefox.dns_over_https.enable_dns_over_https boolean standard mandatory	Enable DNS over HTTPS. Default: false
firefox.dns_over_https.provider choice standard mandatory disabled	Use Provider. Choices: • Cloudflare ← (default) • NextDNS • Custom Disabled: when the variable "Enable DNS over HTTPS" has the value "false".
firefox.dns_over_https.custom_dns_url web address basic mandatory disabled	Custom DNS URL. Validators: • well-known ports (1 to 1023) are allowed • registred ports (1024 to 49151) are allowed • type domainname • the domain name can be a hostname • must starts with 'https://' only Disabled: if "Use Provider" is not "Custom".

FoxyProxy

Note

This family is a namespace.
Path: foxyproxy
standard

Proxy configuration

Note

This family contains lists of variable blocks.
Path: foxyproxy.proxies
standard

Variable	Description
foxyproxy.proxies.title string multiple standard unique	Title or Description.
foxyproxy.proxies.color regexp standard mandatory	Color. Validator: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$" Default: random color value.