rougail-tutorials/README.md

• Summary
• [tutorial v1.1_080] HTTP Proxy with "proxy" type (diff)

[tutorial v1.1_081] HTTPS and SOCKS Proxy

Read the tutorial "HTTPS and SOCKS Proxy" in 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_081

Structure

.
├── firefox
│   ├── 00-proxy.yml
│   ├── 10-manual.yml
│   └── 20-manual.yml
└── types
    └── proxy
        └── 00_type.yml

Contents of the firefox/20-manual.yml file

%YAML 1.2
---
version: 1.1

manual:

  use_for_https: true  # Also use this proxy for HTTPS

  https_proxy:
    description: HTTPS Proxy
    type: proxy
    hidden:
      variable: _.use_for_https

  socks_proxy:
    description: SOCKS Proxy
    type: proxy

    version:
      description: SOCKS host version used by proxy
      choices:
        - v4
        - v5
      default: v5
...

---

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 Default: the value of the variable "Proxy address"
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: the value of the variable "Proxy port"
manual.socks_proxy.version choice mandatory	SOCKS host version used by proxy. Choices: • v4 • v5 ← (default)

---

Let's generate the changelog

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

New variables

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"
manual.socks_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.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: the value of the variable "Proxy port"
manual.socks_proxy.version choice mandatory	SOCKS host version used by proxy. Choices: • v4 • v5 ← (default)

Deleted variables

• manual.https_proxy.address
• manual.socks_proxy.address
• manual.https_proxy.port
• manual.socks_proxy.port
• manual.socks_proxy.version

---

User datas

Example 1

config/01/config.yml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
    port: 3128
  use_for_https: false
  https_proxy:
    address: https.proxy.net

---

Output

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

Note

Caption:

• Variable
• Default value
• Modified value
• (⏳ Original default value)

Variables:

• 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/01/config.yml" (⏳ No proxy)
• 📂 manual (Manual proxy configuration)
  • 📂 http_proxy (HTTP Proxy)
    • 📓 address (Proxy address): http.proxy.net ← loaded from the YAML file "config/01/config.yml"
    • 📓 port (Proxy port): 3128 ← loaded from the YAML file "config/01/config.yml" (⏳ 8080)
  • 📓 use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/01/config.yml" (⏳ true)
  • 📂 https_proxy (HTTPS Proxy)
    • 📓 address (Proxy address): https.proxy.net ← loaded from the YAML file "config/01/config.yml" (⏳ http.proxy.net)
    • 📓 port (Proxy port): 3128
  • 📂 socks_proxy (SOCKS Proxy)
    • 📓 address (Proxy address): http.proxy.net
    • 📓 port (Proxy port): 3128
    • 📓 version (SOCKS host version used by proxy): v5

---

• [tutorial v1.1_090] A conditional disabled variable with type web_address (diff)