rougail-tutorials/DOCUMENTATION.md

7 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
Proxy address.
Validators:
• type domainname
• the domain name can be an IP
manual.http_proxy.port
port mandatory
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 or SOCKS Proxy

Note

This family builds families dynamically.
Path: > - manual.https_proxy

Variable Description
manual.https_proxy.address
manual.socks_proxy.address
domainname mandatory
HTTPS or SOCKS address.
Validators:
• type domainname
• the domain name can be an IP
Default: the value of the variable "Proxy address".
manual.https_proxy.port
manual.socks_proxy.port
port mandatory
HTTPS or SOCKS 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 "Proxy port".
manual.socks_proxy.version
choice mandatory disabled
SOCKS host version used by proxy.
Choices:
• v4
• v5 ← (default)
Disabled: when the identifier is "HTTPS".