rougail-tutorials/README.md

• Summary
• [tutorial 061] A conditional disabled variable (diff)

[tutorial 070] A variable with type "domainname", parameters type and disabled

View the diff

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:  # 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

  "{{ identifier }}_proxy":
    description: "{{ identifier }} Proxy"
    dynamic:
      - HTTPS
      - SOCKS
    hidden:
      jinja: |
        {% if my_identifier == 'HTTPS' and manual.use_for_https %}
        HTTPS is same has HTTP
        {% endif %}        
      params:
        my_identifier:
          type: identifier
      description: |
        in HTTPS case if "manual.use_for_https" is set to True        

    address:
      description: "{{ identifier }} address"
      default:
        variable: manual.http_proxy.address

    port:
      description: "{{ identifier }} port"
      default:
        variable: manual.http_proxy.port

    version:
      description: SOCKS host version used by proxy
      choices:
        - v4
        - v5
      default: v5
      disabled:
        type: identifier
        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
  disabled:
    variable: proxy_mode
    when: No proxy

Generated documentation

foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github

Variables

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

disabled

Disabled: proxy_mode.

HTTP Proxy

Variable	Description
manual.http_proxy.address domainname mandatory	HTTP address. Validator: the domain name can be an IP
manual.http_proxy.port port mandatory	HTTP Port. Default: 8080

Variable	Description
manual.use_for_https boolean mandatory	Also use this proxy for HTTPS. Default: True

"HTTPS Proxy" or "SOCKS Proxy"

hidden

Hidden: in HTTPS case if "manual.use_for_https" is set to True.

This family builds families dynamically.

Identifiers:
- HTTPS
- SOCKS

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

Variable	Description
auto web_address mandatory disabled	Automatic proxy configuration URL. Disabled: proxy_mode.
no_proxy domainname mandatory disabled	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 Disabled: proxy_mode.

User data

Example 1

config/01/config.yaml

---

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml

╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: No proxy

Example 2

config/02/config.yaml

---
proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat
no_proxy: 192.168.1.0/24

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml

╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┣━━ 📓 proxy_mode: Automatic proxy configuration URL (No proxy)
┣━━ 📓 auto: https://auto.proxy.net/wpad.dat
┗━━ 📓 no_proxy: 192.168.1.0/24

• [tutorial 071] A variable with multiple value (diff)