Table of Contents

• Summary
• Description
• Structure
• firefox/00-proxy.yml
• firefox/10-manual.yml
• firefox/20-manual.yml
• firefox/30-auto.yml
• Generated documentation
• Variables
• Manual proxy configuration
• HTTP Proxy
• "HTTPS Proxy" or "SOCKS Proxy"
• User data
• Example 1
• config/01/config.yaml
• Description
• Output
• Example 2
• config/02/config.yaml
• Output
• Example 3
• config/03/config.yaml
• Output

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)

Description

A conditional disabled variable

Add a new "auto" variable.

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

Generated documentation

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

Variables

Variable	Description
proxy_mode choice 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.address domainname basic mandatory	HTTP address. Validator: the domain name can be an IP
manual.http_proxy.port port standard mandatory	HTTP Port. Default: 8080

Variable	Description
manual.use_for_https boolean 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.address domainname 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.port port 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.version choice standard mandatory disabled	SOCKS host version used by proxy. Choices: - v4 - v5 ← (default) Disabled: when the suffix is "HTTPS".

Variable	Description
auto web_address basic mandatory disabled	Automatic proxy configuration URL. Disabled: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL".

User data

Example 1

config/01/config.yaml

---
auto: https://auto.proxy.net/wpad.dat

Description

We cannot configure "auto" if "proxy_mode" is not "Automatic proxy configuration URL".

Output

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

⚠ WARNINGS
└── "cannot access to option "auto (Automatic proxy configuration URL)" because has property "disabled"" but is defined in "/home/gnunux/git/rougail-tutorials/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

Output

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

🛑 ERRORS
┣━━ The following variables are mandatory but have no value:
┗━━   - auto (Automatic proxy configuration URL)

Example 3

config/03/config.yaml

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

Output

foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/03/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