No description
Find a file
2026-05-05 06:54:36 +02:00
config/01 [tutorial v1.1_181] New "FoxyProxy" namespace (config and doc) 2026-05-05 06:54:36 +02:00
firefox [tutorial v1.1_170] A variable with custom validation 2026-05-05 06:54:29 +02:00
foxyproxy [tutorial v1.1_181] New "FoxyProxy" namespace 2026-05-05 06:54:36 +02:00
types/proxy [tutorial v1.1_084] Redefine other parameter in custom type for HTTP 2026-05-05 06:53:22 +02:00
DOCUMENTATION.md [tutorial v1.1_180] Namespace (config and doc) 2026-05-05 06:54:32 +02:00
firefox.png [tutorial v1.1_160] A boolean variable (config and doc) 2026-05-05 06:54:17 +02:00
foxyproxy.png [init] Discover Rougail 2026-05-05 06:51:36 +02:00
install.txt [init] Discover Rougail 2026-05-05 06:51:36 +02:00
README.md [tutorial v1.1_181] New "FoxyProxy" namespace (config and doc) 2026-05-05 06:54:36 +02:00
tree.html [tutorial v1.1_181] New "FoxyProxy" namespace (config and doc) 2026-05-05 06:54:36 +02:00

[tutorial v1.1_181] New "FoxyProxy" namespace

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_181

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
├── foxyproxy
│   └── 00-foxyproxy.yml
└── types
    └── proxy
        └── 00-type.yml


Contents of the foxyproxy/00-foxyproxy.yml file

%YAML 1.2
---
version: 1.1
...


Let's generate the documentation

rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc

View the documentation file


User datas

Example 1

config/01/config.yml

---

Output

rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml

Note

Caption:

  • Variable
  • Default value

Variables:

  • 📂 firefox (Firefox)
    • 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
    • 📂 dns_over_https (DNS over HTTPS)
      • 📓 enable_dns_over_https (Enable DNS over HTTPS): false