• Summary
• [tutorial v1.1_074] Help (diff)

[tutorial v1.1_075)] A variable

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_075

Structure

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

Contents of the firefox/50-prompt_authentication.yml file

%YAML 1.2
---
version: 1.1

prompt_authentication:
  description: Prompt for authentication if password is saved
  default: true
  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

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
no_proxy domainname disabled unique multiple	Address for which proxy will be desactivated. Connections to localhost, 127.0.0.1/8 and ::1 are never proxied. 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"
prompt_authentication boolean mandatory disabled	Prompt for authentication if password is saved. Default: true Disabled: when the variable "proxy_mode" has the value "No proxy"

Let's generate the changelog

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

New variable

Variable	Description
prompt_authentication boolean mandatory disabled	Prompt for authentication if password is saved. Default: true Disabled: when the variable "proxy_mode" has the value "No proxy"

User datas

Example 1

config/01/config.yml

---

Output

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

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

Example 2

config/02/config.yml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net

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: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
proxy_dns_socks5: true

Output

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

🔔 WARNINGS
┗━━ variable or family "proxy_dns_socks5" does not exist, it will be ignored when loading from the YAML file "config/03/config.yml"
🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ Automatic proxy configuration URL

Example 4

config/04/config.yml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
  socks_proxy:
    version: v4

Output

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

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

• [tutorial v1.1_076] A variable (diff)