• Summary
• [tutorial v1.1_062] Jinja with a description (diff)

[tutorial v1.1_065)] A variable with type "web_address"

View the diff

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_065

Structure

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

Contents of the firefox/30-auto.yml file

%YAML 1.2
---
version: 1.1

auto:
  description: Automatic proxy configuration URL
  type: web_address
...

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

manual

disabled

Disabled: when the variable "proxy_mode" hasn't the value "Manual proxy configuration"

HTTP Proxy

manual.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. 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

This family builds families dynamically

manual.https_proxy
manual.socks_proxy

hidden

Hidden: in HTTPS case if "_.use_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. Validator: the domain name can be an IP Default: the value of the variable "manual.http_proxy.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 "manual.http_proxy.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	Automatic proxy configuration URL. Validator: the domain name in web address can be only a hostname

Let's generate the changelog

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

Modified variable

Variable	Description
auto disabled web_address mandatory	Automatic proxy configuration URL. Validator: the domain name in web address can be only a hostname Disabled: {'message': 'when the variable "{0}" hasn't the value "Automatic proxy configuration URL"', 'path': {'path': 'proxy_mode'}, 'description': 'Configure Proxy Access to the Internet'}

User datas

Example 1

config/01/config.yml

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

Output

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

╭──────── Caption ────────╮
│ Variable Default value  │
│          Modified value │
╰─────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: No proxy
┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/01/config.yml"

Example 2

config/02/config.yml

---
proxy_mode: Automatic proxy configuration URL

Output

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

🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Automatic proxy configuration URL

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 ───────────────╮
│ 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"

• [tutorial v1.1_070] A variable with type "domainname", parameters type and disabled (diff)