• Summary
• [tutorial v1.1_092] A non mandatory variable (diff)

[tutorial v1.1_093] Examples

View the diff

Read the documentation

Screenshot

Clone and install

To test this tutorial, you need to download this repository and install Rougail:

git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
cd rougail-tutorials
python -m venv venv_rougail
. venv_rougail/bin/activate
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml

Then switch to the tutorial page:

git switch --detach v1.1_093

Structure

.
└── firefox
    ├── 00-proxy.yml
    ├── 10-manual.yml
    ├── 20-manual.yml
    ├── 30-auto.yml
    └── 40-no_proxy.yml

Contents of the firefox/40-no_proxy.yml file

%YAML 1.2
---
version: 1.1

no_proxy:
  description: Address for which proxy will be desactivated
  examples:
    - .mozilla.org
    - .net.nz
    - 192.168.1.0/24
  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
...

Let's generate the documentation

rougail -m firefox/ -o doc

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

🛈 Informations

Path: manual
disabled
Disabled: when the variable "Configure Proxy Access to the Internet" hasn't the value "Manual proxy configuration"

HTTP Proxy

🛈 Informations

Path: manual.http_proxy

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

🛈 Informations

This family builds families dynamically.
Path:

• manual.https_proxy
• manual.socks_proxy
  hidden
  Hidden: in HTTPS case if "Also use this proxy for HTTPS" is set to "true"
  Identifiers:
• HTTPS
• SOCKS

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 "HTTP 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 "HTTP Port"
manual.https_proxy.version 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. Validators: • well-known ports (1 to 1023) are allowed • registred ports (1024 to 49151) are allowed • type domainname • the domain name can be a hostname Disabled: when the variable "Configure Proxy Access to the Internet" hasn't the value "Automatic proxy configuration URL"
no_proxy domainname multiple disabled unique	Address for which proxy will be desactivated. Validators: • type domainname • 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 "Configure Proxy Access to the Internet" has the value "No proxy"

Let's generate the changelog

rougail -m firefox/ -o doc --doc.contents changelog

Modified variable

Variable	Description
no_proxy domainname multiple disabled unique	Address for which proxy will be desactivated. Validators: • type domainname • 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 "Configure Proxy Access to the Internet" has the value "No proxy"

User datas

Example 1

config/01/config.yml

---

Output

rougail -m firefox/ -u yaml -yf config/01/config.yml

╭──────────────────── Caption ─────────────────────╮
│ Undocumented but modified variable Default value │
╰──────────────────────────────────────────────────╯
Variables:
┗━━ 📓 Configure Proxy Access to the Internet: No proxy

Example 2

config/02/config.yml

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

Output

rougail -m firefox/ -u yaml -yf config/02/config.yml

╭─────────────────────────── Caption ────────────────────────────╮
│ Undocumented but modified variable Modified value              │
│                                    (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL
┃   ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ 
┃   loaded from the YAML file "config/02/config.yml"
┗━━ 📓 Address for which proxy will be desactivated:
    ┣━━ example.net ◀ loaded from the YAML file "config/02/config.yml"
    ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/02/config.yml"

Example 3

config/03/config.yml

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

Output

rougail -m firefox/ -u yaml -yf config/03/config.yml

╭─────────────────────────── Caption ────────────────────────────╮
│ Undocumented but modified variable Modified value              │
│                                    (⏳ Original default value) │
╰────────────────────────────────────────────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL
┃   ◀ loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ 
┃   loaded from the YAML file "config/03/config.yml"
┗━━ 📓 Address for which proxy will be desactivated: 

• [tutorial v1.1_094] Help (diff)