rougail-tutorials/DOCUMENTATION.md

12 KiB

Variable Description
proxy_mode
choice 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: manual
disabled
Disabled: when the variable "Configure Proxy Access to the Internet" hasn't the value "Manual proxy configuration".

HTTP Proxy

Note

Path: manual.http_proxy

Variable Description
manual.http_proxy.address
domainname mandatory
HTTP proxy address.
Validators:
• type domainname
• the domain name can be an IP
manual.http_proxy.port
port 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
manual.use_for_https
boolean mandatory
Also use this proxy for HTTPS.
Default: true

HTTPS Proxy

Note

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

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

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