stove/rougail-tutorials
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
rougail-tutorials/README.md

19 KiB
Raw Blame History

[tutorial v1.1_105] A conditional disabled boolean variable

View the diff

Read the documentation

Screenshot

Firefox Proxy setting

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_105

Structure

.
├── firefox
│   ├── 00-proxy.yml
│   ├── 10-manual.yml
│   ├── 20-manual.yml
│   ├── 30-auto.yml
│   ├── 40-no_proxy.yml
│   └── 50-prompt_authentication.yml
└── types
    └── proxy
        └── 00_type.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/ --types types/proxy -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

Note

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

HTTP Proxy

Note

Path: manual.http_proxy

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

Note

Path: manual.https_proxy
hidden
Hidden: when the variable "Also use this proxy for HTTPS" has the value "true"

Variable Description
manual.https_proxy.address
domainname mandatory		 Proxy address.
Validators:
• type domainname
• the domain name can be an IP
Default: the value of the variable "Proxy address"
manual.https_proxy.port
port mandatory		 Proxy 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 "Proxy port"
SOCKS Proxy

Note

Path: manual.socks_proxy

Variable Description
manual.socks_proxy.address
domainname mandatory		 Proxy address.
Validators:
• type domainname
• the domain name can be an IP
manual.socks_proxy.port
port mandatory		 Proxy 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
manual.socks_proxy.version
choice mandatory		 SOCKS host version used by proxy.
Choices:
• v4
• v5 ← (default)
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.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
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"
prompt_authentication
boolean mandatory disabled		 Prompt for authentication if password is saved.
Default: true
Disabled: when the variable "Configure Proxy Access to the Internet" has the value "No proxy"

Let's generate the changelog

rougail -m firefox/ --types types/proxy -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml

New variable

Variable Description
prompt_authentication
boolean mandatory disabled		 Prompt for authentication if password is saved.
Default: true
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/ --types types/proxy -u yaml -yf config/01/config.yml

Note

Caption:

  • Variable
  • Default value

Variables:

  • 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy

Example 2

config/02/config.yml

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

Output

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

Caution

  • manual (Manual proxy configuration)
    • socks_proxy (SOCKS Proxy)
      • address (Proxy address): 🛑 mandatory variable but has no value

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/ --types types/proxy -u yaml -yf config/03/config.yml

Caution

  • variable or family "proxy_dns_socks5" does not exist so cannot load "proxy_dns_socks5", it will be ignored when loading from the YAML file "config/03/config.yml"
  • manual (Manual proxy configuration)
    • socks_proxy (SOCKS Proxy)
      • address (Proxy address): 🛑 mandatory variable but has no value

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/ --types types/proxy -u yaml -yf config/04/config.yml

Caution

  • manual (Manual proxy configuration)
    • socks_proxy (SOCKS Proxy)
      • address (Proxy address): 🛑 mandatory variable but has no value