16 KiB
16 KiB
[tutorial 037] Family: a dynamic family
Screenshot
Structure
firefox/00-proxy.yml
---
proxy_mode:
description: Configure Proxy Access to the Internet
choices:
- No proxy
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL
default: No proxy
firefox/10-manual.yml
---
manual:
description: Manual proxy configuration
disabled:
variable: proxy_mode
when_not: 'Manual proxy configuration'
http_proxy:
description: HTTP Proxy
address:
description: HTTP address
type: domainname
params:
allow_ip: true
port:
description: HTTP Port
type: port
default: 8080
firefox/20-manual.yml
---
manual:
use_for_https:
description: Also use this proxy for HTTPS
default: true
"{{ identifier }}_proxy":
description: "{{ identifier }} Proxy"
dynamic:
- HTTPS
- SOCKS
hidden:
variable: manual.use_for_https
address:
description: "{{ identifier }} address"
default:
variable: manual.http_proxy.address
port:
description: "{{ identifier }} port"
default:
variable: manual.http_proxy.port
Generated documentation
foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
Variables
Variable | Description |
---|---|
proxy_modechoice 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
disabled
Disabled: proxy_mode.
HTTP Proxy
Variable | Description |
---|---|
manual.http_proxy.addressdomainname mandatory |
HTTP address. Validator: the domain name can be an IP |
manual.http_proxy.portport mandatory |
HTTP Port. Default: 8080 |
Variable | Description |
---|---|
manual.use_for_httpsboolean mandatory |
Also use this proxy for HTTPS. Default: True |
"HTTPS Proxy" or "SOCKS Proxy"
hidden
Hidden: manual.use_for_https.
This family builds families dynamically.
Identifiers:
- HTTPS
- SOCKS
Variable | Description |
---|---|
manual.https_proxy.address or manual.socks_proxy.addressdomainname mandatory |
"HTTPS address" or "SOCKS address". Validator: the domain name can be an IP Default: the value of the variable "manual.http_proxy.address". |
manual.https_proxy.port or manual.socks_proxy.portport mandatory |
"HTTPS port" or "SOCKS port". Default: the value of the variable "manual.http_proxy.port". |