No description
firefox | ||
firefox.png | ||
foxyproxy.png | ||
README.md |
Table of Contents
Summary
- [tutorial 001] An empty file (diff)
- [tutorial 002] A first variable (diff)
- [tutorial 003] A first variable (diff)
- [tutorial 004] The variable description (diff)
- [tutorial 005] A default value (diff)
- [tutorial 006] A variable with type choice (diff)
- [tutorial 007] Choice type is optional (diff)
- [tutorial 010] A family (diff)
- [tutorial 011] Conditional desactived family (diff)
- [tutorial 012] Conditional desactived family (diff)
- [tutorial 013] A sub family (diff)
- [tutorial 014] Family in "shorthand" mode (diff)
- [tutorial 015] Family in "shorthand" mode (diff)
- [tutorial 016] Family in "shorthand" mode (diff)
- [tutorial 017] Family in "shorthand" mode (diff)
- [tutorial 018] Family in "shorthand" mode (diff)
- [tutorial 020] A boolean variable (diff)
- [tutorial 021] Bases type is optional if default value (diff)
- [tutorial 022] A variable in "shorthand" mode (diff)
- [tutorial 023] Conditional hidden family and calculated default value (diff)
- [tutorial 024] Conditional hidden family and calculated default value (diff)
- [tutorial 025] Conditional hidden family and calculated default value (diff)
- [tutorial 026] A dynamic family (diff)
- [tutorial 027] A dynamic family (diff)
- [tutorial 028] Description of Jinja calculation (diff)
- [tutorial 029] Description of Jinja calculation (diff)
- [tutorial 030] A conditional disabled variable (diff)
- [tutorial 040] A conditional disabled variable (diff)
- [tutorial 041] A variable multi (diff)
- [tutorial 042] A non mandatory variable (diff)
- [tutorial 043] Examples (diff)
Description
Examples
We can add example (only for documentation).
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: # 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: true # Also use this proxy for HTTPS
"{{ suffix }}_proxy":
description: "{{ suffix }} Proxy"
dynamic:
- HTTPS
- SOCKS
hidden:
jinja: |
{% if suffix == 'HTTPS' and _.use_for_https %}
HTTPS is same has HTTP
{% endif %}
params:
suffix:
type: suffix
description: |
in HTTPS case if "manual.use_for_https" is set to True
address:
description: "{{ suffix }} address"
default:
variable: __.http_proxy.address
port:
description: "{{ suffix }} port"
default:
variable: __.http_proxy.port
version:
description: SOCKS host version used by proxy
choices:
- v4
- v5
default: v5
disabled:
type: suffix
when: 'HTTPS'
firefox/30-auto.yml
---
auto:
description: Automatic proxy configuration URL
type: web_address
disabled:
variable: _.proxy_mode
when_not: Automatic proxy configuration URL
firefox/40-no_proxy.yml
---
no_proxy:
description: Address for which proxy will be desactivated
type: "domainname"
params:
allow_ip: true
allow_cidr_network: true
allow_without_dot: true
allow_startswith_dot: true
multi: true
mandatory: false
disabled:
variable: _.proxy_mode
when: No proxy
examples:
- .mozilla.org
- .net.nz
- 192.168.1.0/24
Generated documentation
foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
Variables
Variable | Description |
---|---|
proxy_modechoice 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
basic
disabled
Disabled: when the variable "proxy_mode" hasn't the value "Manual proxy configuration".
HTTP Proxy
basic
Variable | Description |
---|---|
manual.http_proxy.addressdomainname basic mandatory |
HTTP address. Validator: the domain name can be an IP |
manual.http_proxy.portport standard mandatory |
HTTP Port. Default: 8080 |
Variable | Description |
---|---|
manual.use_for_httpsboolean standard mandatory |
Also use this proxy for HTTPS. Default: True |
"HTTPS Proxy" or "SOCKS Proxy"
standard
hidden
Hidden: in HTTPS case if "manual.use_for_https" is set to True.
This family builds families dynamically.
Suffixes:
- HTTPS
- SOCKS
Variable | Description |
---|---|
manual.https_proxy.address or manual.socks_proxy.addressdomainname standard 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 standard mandatory |
"HTTPS port" or "SOCKS port". Default: the value of the variable "manual.http_proxy.port". |
manual.https_proxy.version or manual.socks_proxy.versionchoice standard mandatory disabled |
SOCKS host version used by proxy. Choices: - v4 - v5 ← (default) Disabled: when the suffix is "HTTPS". |
Variable | Description |
---|---|
autoweb_address basic mandatory disabled |
Automatic proxy configuration URL. Disabled: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL". |
no_proxydomainname standard disabled unique multiple |
Address for which proxy will be desactivated. Validators: - 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 "proxy_mode" has the value "No proxy". |