• Summary
• [tutorial v1.1_102] A web_address variable (diff)

[tutorial v1.1_103)] A variable with custom validation

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_103

Structure

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

Contents of the firefox/60-dns_over_https.yml file

%YAML 1.2
---
version: 1.1

dns_over_https:  # DNS over HTTPS

  enable_dns_over_https: false  # Enable DNS over HTTPS

  provider:
    description: Use Provider
    choices:
      - Cloudflare
      - NextDNS
      - Custom
    default: Cloudflare
    disabled:
      variable: _.enable_dns_over_https
      when: false

  custom_dns_url:
    description: Custom DNS URL
    type: web_address
    validators:
      - jinja: |-
          {% if _.custom_dns_url.startswith('http://') %}
            only https is allowed
          {% endif %}          
        description: must starts with 'https://' only
    disabled:
      jinja: |-
        {% if _.provider is propertyerror or _.provider != 'Custom' %}
          provider is not custom
        {% endif %}        
      description: if "_.provider" is not "Custom"
...

Let's generate the documentation

rougail -m firefox/ --modes_level basic standard advanced -o doc

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

manual

basic disabled

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

HTTP Proxy

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

standard 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 standard 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 standard 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 standard mandatory disabled	SOCKS host version used by proxy. Choices: - v4 - v5 ← (default) Disabled: when the identifier is "HTTPS"

Variable	Description
auto web_address basic mandatory disabled	Automatic proxy configuration URL. Validator: the domain name in web address can be only a hostname Disabled: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL"
no_proxy domainname standard 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 standard mandatory disabled	Prompt for authentication if password is saved. Default: true Disabled: when the variable "proxy_mode" has the value "No proxy"
proxy_dns_socks5 boolean advanced mandatory disabled	Use proxy DNS when using SOCKS v5. Default: false Disabled: if "firefox.proxy_mode" is not "Manual proxy configuration"
or "firefox.manual.socks_proxy.version" is "v4"

DNS over HTTPS

dns_over_https

basic

Variable	Description
dns_over_https.enable_dns_over_https boolean standard mandatory	Enable DNS over HTTPS. Default: false
dns_over_https.provider choice standard mandatory disabled	Use Provider. Choices: - Cloudflare ← (default) - NextDNS - Custom Disabled: when the variable "dns_over_https.enable_dns_over_https" has the value "false"
dns_over_https.custom_dns_url web_address basic mandatory disabled	Custom DNS URL. Validators: - the domain name in web address can be only a hostname - must starts with 'https://' only Disabled: if "_.provider" is not "Custom"

Let's generate the changelog

rougail -m firefox/ --modes_level basic standard advanced -o doc --doc.contents changelog

Modified variable

Variable	Description
dns_over_https.custom_dns_url web_address basic mandatory disabled	Custom DNS URL. Validators: - the domain name in web address can be only a hostname - must starts with 'https://' only Disabled: if "_.provider" is not "Custom"

User datas

Example 1

config/01/config.yml

---

Output

rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/01/config.yml

╭─────── Caption ────────╮
│ Variable Default value │
╰────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: No proxy
┗━━ 📂 DNS over HTTPS
    ┗━━ 📓 Enable DNS over HTTPS: false

Example 2

config/02/config.yml

---
dns_over_https:
  enable_dns_over_https: true

Output

rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/02/config.yml

╭────────────── Caption ───────────────╮
│ Variable Default value               │
│          Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: No proxy
┗━━ 📂 DNS over HTTPS
    ┣━━ 📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file "config/02/config.yml" (⏳ false)
    ┗━━ 📓 Use Provider: Cloudflare

Example 3

config/03/config.yml

---
dns_over_https:
  enable_dns_over_https: true
  provider: Custom
  custom_dns_url: http://dns.net

Output

rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/03/config.yml

🔔 WARNINGS
┗━━ the value "http://dns.net" is an invalid URL for "dns_over_https.custom_dns_url" (Custom DNS URL), only https is allowed, it will be ignored when loading from the YAML file "config/03/config.yml"
🛑 ERRORS
┗━━ The following variables are mandatory but have no value:
    ┗━━ DNS over HTTPS
        ┗━━ Custom DNS URL

Example 4

config/04/config.yml

---
dns_over_https:
  enable_dns_over_https: true
  provider: Custom
  custom_dns_url: https://dns.net

Output

rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/04/config.yml

╭────────────── Caption ───────────────╮
│ Variable Default value               │
│          Modified value              │
│          (⏳ Original default value) │
╰──────────────────────────────────────╯
Variables:
┣━━ 📓 Configure Proxy Access to the Internet: No proxy
┗━━ 📂 DNS over HTTPS
    ┣━━ 📓 Enable DNS over HTTPS: true ◀ loaded from the YAML file "config/04/config.yml" (⏳ false)
    ┣━━ 📓 Use Provider: Custom ◀ loaded from the YAML file "config/04/config.yml" (⏳ Cloudflare)
    ┗━━ 📓 Custom DNS URL: https://dns.net ◀ loaded from the YAML file "config/04/config.yml"

• [tutorial v1.1_110] Namespace (diff)