[tutorial v1.1_042] Copy HTTP manual proxy to HTTPS manual proxy

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_042

Structure

.
└── firefox
    ├── 00-proxy.yml
    ├── 10-manual.yml
    └── 20-manual.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:  # HTTPS Proxy

    address:
      description: HTTPS address
      type: domainname
      params:
        allow_ip: true

    port:
      description: HTTPS Port
      type: port
      default: 8080
...

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

🛈 Informations

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

HTTP Proxy

🛈 Informations

Path: manual.http_proxy

Variable	Description
manual.http_proxy.address `domainname` `mandatory`	HTTP address. Validators: • type domainname • 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

🛈 Informations

Path: manual.https_proxy

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

Let's generate the changelog

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

New variables

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

[tutorial v1.1_043] A conditional hidden family (diff)

10 KiB Raw Blame History