rougail-tutorials/README.md

- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[tutorial v1.1_111] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111))

# [tutorial v1.1_112] xxx

[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_112~1..v1.1_112)

[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx)


## Screenshot


<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>


## Clone and install


To test this tutorial, you need to download this repository and install Rougail:

```shell
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:

```shell
git switch --detach v1.1_112
```

## Structure


<p>
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./">.</a><br/>
	├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/">firefox</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/10-manual.yml">10-manual.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/20-manual.yml">20-manual.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/30-auto.yml">30-auto.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
	│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br/>
	│   └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/empty.yml">empty.yml</a><br/>
	└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./foxyproxy/">foxyproxy</a><br/>
	    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
<br/><br/></p>

Contents of the foxyproxy/00-foxyproxy.yml file

```yml
%YAML 1.2
---
version: 1.1

proxies:
  description: Proxy configuration
  type: leadership

  title:
    description: Title or Description
    mandatory: false

  color:
    description: Color
    regexp: ^#(?:[0-9a-f]{3}){1,2}$
    default:
      jinja: >-
        #

        {%- for i in range(6) -%}
          {{- '0123456789abcdef' | random -}}
        {%- endfor -%}
      description: random color value
    auto_save: true
...

```
### Let's generate the documentation

```shell
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc
```
#### Firefox

> **🛈 Informations**
> 
> **Path**: firefox\
> `basic`

| Variable                                                                                                                                                                                      | Description                                                                                                                                                                                                                                                                  |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="firefox.proxy_mode" name="firefox.proxy_mode">firefox.proxy_mode</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>•&nbsp;No proxy **← (default)**<br/>•&nbsp;Auto-detect proxy settings for this network<br/>•&nbsp;Use system proxy settings<br/>•&nbsp;Manual proxy configuration<br/>•&nbsp;Automatic proxy configuration URL |

##### Manual proxy configuration

> **🛈 Informations**
> 
> **Path**: firefox.manual\
> `basic` *`disabled`*\
> **Disabled**: when the variable "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" hasn't the value "Manual proxy configuration"

###### HTTP Proxy

> **🛈 Informations**
> 
> **Path**: firefox.manual.http_proxy\
> `basic`

| Variable                                                                                                                                                                                                                                    | Description                                                                                                                                                                                                                |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="firefox.manual.http_proxy.address" name="firefox.manual.http_proxy.address">firefox.manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP                                                                                                                      |
| **<a id="firefox.manual.http_proxy.port" name="firefox.manual.http_proxy.port">firefox.manual.http_proxy.port</a>**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`             | HTTP Port.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;private ports (greater than 49152) are allowed<br/>**Default**: 8080 |

| Variable                                                                                                                                                                                                                     | Description                                          |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **<a id="firefox.manual.use_for_https" name="firefox.manual.use_for_https">firefox.manual.use_for_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |

###### *HTTPS* Proxy or *SOCKS* Proxy

> **🛈 Informations**
> 
> This family builds families dynamically.\
> **Path**: 
> - firefox.manual.*https*_proxy
> - firefox.manual.*socks*_proxy\
> `standard` *`hidden`*\
> **Hidden**: in HTTPS case if "[Also use this proxy for HTTPS](#firefox.manual.use_for_https)" is set to "true"\
> **Identifiers**: 
> - HTTPS
> - SOCKS

| Variable                                                                                                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                                                                                  |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="firefox.manual.:::identifier:::_proxy.address" name="firefox.manual.:::identifier:::_proxy.address">firefox.manual.*https*_proxy.address</a>**<br/>**firefox.manual.*socks*_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`          | *HTTPS* or *SOCKS* address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP<br/>**Default**: the value of the variable "[HTTP address](#firefox.manual.http_proxy.address)"                                                                                          |
| **<a id="firefox.manual.:::identifier:::_proxy.port" name="firefox.manual.:::identifier:::_proxy.port">firefox.manual.*https*_proxy.port</a>**<br/>**firefox.manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                            | *HTTPS* or *SOCKS* port.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;private ports (greater than 49152) are allowed<br/>**Default**: the value of the variable "[HTTP Port](#firefox.manual.http_proxy.port)" |
| **<a id="firefox.manual.:::identifier:::_proxy.version" name="firefox.manual.:::identifier:::_proxy.version">firefox.manual.*https*_proxy.version</a>**<br/>**firefox.manual.*socks*_proxy.version**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | SOCKS host version used by proxy.<br/>**Choices**: <br/>•&nbsp;v4<br/>•&nbsp;v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS"                                                                                                                                                             |

| Variable                                                                                                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="firefox.auto" name="firefox.auto">firefox.auto</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`*                                                   | Automatic proxy configuration URL.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" hasn't the value "Automatic proxy configuration URL"                                                                                                                                                                                  |
| **<a id="firefox.no_proxy" name="firefox.no_proxy">firefox.no_proxy</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`disabled`* `unique`                             | Address for which proxy will be desactivated.<br/>Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can starts by a dot<br/>•&nbsp;the domain name can be a hostname<br/>•&nbsp;the domain name can be an IP<br/>•&nbsp;the domain name can be network in CIDR format<br/>**Examples**: <br/>•&nbsp;.mozilla.org<br/>•&nbsp;.net.nz<br/>•&nbsp;192.168.1.0/24<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" has the value "No proxy" |
| **<a id="firefox.prompt_authentication" name="firefox.prompt_authentication">firefox.prompt_authentication</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" has the value "No proxy"                                                                                                                                                                                                                                                                                                                                                                                   |
| **<a id="firefox.proxy_dns_socks5" name="firefox.proxy_dns_socks5">firefox.proxy_dns_socks5</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` *`disabled`*                | Use proxy DNS when using SOCKS v5.<br/>**Default**: false<br/>**Disabled**: if "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" is not "Manual proxy configuration"<br/>or "[SOCKS host version used by proxy](#firefox.manual.:::identifier:::_proxy.version)" is "v4"                                                                                                                                                                                                                                                                                               |

##### DNS over HTTPS

> **🛈 Informations**
> 
> **Path**: firefox.dns_over_https\
> `basic`

| Variable                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                 |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="firefox.dns_over_https.enable_dns_over_https" name="firefox.dns_over_https.enable_dns_over_https">firefox.dns_over_https.enable_dns_over_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.<br/>**Default**: false                                                                                                                                                                                                                                                                                                               |
| **<a id="firefox.dns_over_https.provider" name="firefox.dns_over_https.provider">firefox.dns_over_https.provider</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*                            | Use Provider.<br/>**Choices**: <br/>•&nbsp;Cloudflare **← (default)**<br/>•&nbsp;NextDNS<br/>•&nbsp;Custom<br/>**Disabled**: when the variable "[Enable DNS over HTTPS](#firefox.dns_over_https.enable_dns_over_https)" has the value "false"                                                                                                               |
| **<a id="firefox.dns_over_https.custom_dns_url" name="firefox.dns_over_https.custom_dns_url">firefox.dns_over_https.custom_dns_url</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`*        | Custom DNS URL.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be a hostname<br/>•&nbsp;must starts with 'https://' only<br/>**Disabled**: if "[Use Provider](#firefox.dns_over_https.provider)" is not "Custom" |

#### FoxyProxy

> **🛈 Informations**
> 
> **Path**: foxyproxy\
> `basic`

##### Proxy configuration

> **🛈 Informations**
> 
> This family contains lists of variable blocks.\
> **Path**: foxyproxy.proxies\
> `basic`

| Variable                                                                                                                                                                                                                  | Description                                                                                                                 |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| **<a id="foxyproxy.proxies.title" name="foxyproxy.proxies.title">foxyproxy.proxies.title</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique`      | Title or Description.                                                                                                       |
| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |

### Let's generate the changelog

```shell
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc --doc.contents changelog
```
#### Modified variable

| Variable                                                                                                                                                                                                                             | Description                                                                                                                                       |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` <ins>`auto modified`</ins> | Color.<br/>**Validator**: <ins>text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"</ins><br/>**Default**: <ins>random color value</ins> |


## User datas

### Example 1

#### config/01/config.yml


```yml
---
```
#### Output

```shell
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u yaml -yf config/01/config.yml
```
<pre>╭──────────────────── Caption ─────────────────────╮
│ <span style="color: #5c5cff">Undocumented variable</span>              <span style="color: #ffd700">Default value</span> │
│ <span style="color: #ff0000">Undocumented but modified variable</span>               │
╰──────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">Firefox</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">DNS over HTTPS</span>
<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Enable DNS over HTTPS</span>: <span style="color: #ffd700">false</span>
<span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">FoxyProxy</span>
</pre>


- [[tutorial v1.1_113] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_113/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_113~1..v1.1_113))
-												[tutorial v1.1_000] Creating a structure file (config and doc)

											
										
										
											2025-12-02 16:18:16 +01:00
+								- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
-												[tutorial v1.1_112] xxx (config and doc)

											
										
										
											2025-12-02 16:19:25 +01:00
+								- [[tutorial v1.1_111] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111))
-												[tutorial v1.1_000] Creating a structure file (config and doc)

											
										
										
											2025-12-02 16:18:16 +01:00
-												[tutorial v1.1_112] xxx (config and doc)

											
										
										
											2025-12-02 16:19:25 +01:00
+								# [tutorial v1.1_112] xxx
-												[tutorial v1.1_000] Creating a structure file (config and doc)

											
										
										
											2025-12-02 16:18:16 +01:00
-												[tutorial v1.1_112] xxx (config and doc)

											
										
										
											2025-12-02 16:19:25 +01:00
+								[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_112~1..v1.1_112)
-												[tutorial v1.1_000] Creating a structure file (config and doc)

											
										
										
											2025-12-02 16:18:16 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx)
-												[tutorial v1.1_000] Creating a structure file (config and doc)

											
										
										
											2025-12-02 16:18:16 +01:00
-												[init] Discover Rougail

											
										
										
											2025-12-02 16:18:14 +01:00
+								## Screenshot
 								<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
 								## Clone and install
 								To test this tutorial, you need to download this repository and install Rougail:
 								```shell
 								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:
 								```shell
-												[tutorial v1.1_112] xxx (config and doc)

											
										
										
											2025-12-02 16:19:25 +01:00
+								git switch --detach v1.1_112
-												[init] Discover Rougail

											
										
										
											2025-12-02 16:18:14 +01:00
+								```
-												[tutorial v1.1_000] Creating a structure file (config and doc)

											
										
										
											2025-12-02 16:18:16 +01:00
 								## Structure
 								<p>
-												[tutorial v1.1_112] xxx (config and doc)

											
										
										
											2025-12-02 16:19:25 +01:00
+								<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./">.</a><br/>
 									├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/">firefox</a><br/>
 									│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
 									│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/10-manual.yml">10-manual.yml</a><br/>
 									│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/20-manual.yml">20-manual.yml</a><br/>
 									│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/30-auto.yml">30-auto.yml</a><br/>
 									│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
 									│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
 									│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
 									│   ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br/>
 									│   └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./firefox/empty.yml">empty.yml</a><br/>
 									└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./foxyproxy/">foxyproxy</a><br/>
 									    └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
-												[tutorial v1.1_000] Creating a structure file (config and doc)

											
										
										
											2025-12-02 16:18:16 +01:00
+								<br/><br/></p>
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								Contents of the foxyproxy/00-foxyproxy.yml file
-												[tutorial v1.1_000] Creating a structure file (config and doc)

											
										
										
											2025-12-02 16:18:16 +01:00
 								```yml
 								%YAML 1.2
 								---
 								version: 1.1
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
 								proxies:
 								  description: Proxy configuration
 								  type: leadership
 								  title:
 								    description: Title or Description
 								    mandatory: false
-												[tutorial v1.1_112] xxx (config and doc)

											
										
										
											2025-12-02 16:19:25 +01:00
+								  color:
 								    description: Color
 								    regexp: ^#(?:[0-9a-f]{3}){1,2}$
 								    default:
 								      jinja: >-
 								        #
 								        {%- for i in range(6) -%}
 								          {{- '0123456789abcdef' | random -}}
 								        {%- endfor -%}
 								      description: random color value
 								    auto_save: true
-												[tutorial v1.1_000] Creating a structure file (config and doc)

											
										
										
											2025-12-02 16:18:16 +01:00
+								...
 								```
-												[tutorial v1.1_001] Let’s add our first variable (config and doc)

											
										
										
											2025-12-02 16:18:18 +01:00
+								### Let's generate the documentation
 								```shell
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc
-												[tutorial v1.1_001] Let’s add our first variable (config and doc)

											
										
										
											2025-12-02 16:18:18 +01:00
+								```
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								#### Firefox
 								> **🛈 Informations**
 								>
 								> **Path**: firefox\
 								> `basic`
-												[tutorial v1.1_001] Let’s add our first variable (config and doc)

											
										
										
											2025-12-02 16:18:18 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								| Variable                                                                                                                                                                                      | Description                                                                                                                                                                                                                                                                  |
 								|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 								| **<a id="firefox.proxy_mode" name="firefox.proxy_mode">firefox.proxy_mode</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>•&nbsp;No proxy **← (default)**<br/>•&nbsp;Auto-detect proxy settings for this network<br/>•&nbsp;Use system proxy settings<br/>•&nbsp;Manual proxy configuration<br/>•&nbsp;Automatic proxy configuration URL |
 								##### Manual proxy configuration
-												[tutorial v1.1_041] A conditional disabled family (config and doc)

											
										
										
											2025-12-02 16:18:37 +01:00
 								> **🛈 Informations**
 								>
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								> **Path**: firefox.manual\
-												[tutorial v1.1_098] A variable in avanced mode (config and doc)

											
										
										
											2025-12-02 16:19:11 +01:00
+								> `basic` *`disabled`*\
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								> **Disabled**: when the variable "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" hasn't the value "Manual proxy configuration"
-												[tutorial v1.1_041] A conditional disabled family (config and doc)

											
										
										
											2025-12-02 16:18:37 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								###### HTTP Proxy
-												[tutorial v1.1_041] A conditional disabled family (config and doc)

											
										
										
											2025-12-02 16:18:37 +01:00
 								> **🛈 Informations**
 								>
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								> **Path**: firefox.manual.http_proxy\
-												[tutorial v1.1_098] A variable in avanced mode (config and doc)

											
										
										
											2025-12-02 16:19:11 +01:00
+								> `basic`
-												[tutorial v1.1_041] A conditional disabled family (config and doc)

											
										
										
											2025-12-02 16:18:37 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								| Variable                                                                                                                                                                                                                                    | Description                                                                                                                                                                                                                |
 								|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 								| **<a id="firefox.manual.http_proxy.address" name="firefox.manual.http_proxy.address">firefox.manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP                                                                                                                      |
 								| **<a id="firefox.manual.http_proxy.port" name="firefox.manual.http_proxy.port">firefox.manual.http_proxy.port</a>**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`             | HTTP Port.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
-												[tutorial v1.1_041] A conditional disabled family (config and doc)

											
										
										
											2025-12-02 16:18:37 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								| Variable                                                                                                                                                                                                                     | Description                                          |
 								|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
 								| **<a id="firefox.manual.use_for_https" name="firefox.manual.use_for_https">firefox.manual.use_for_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
-												[tutorial v1.1_041] A conditional disabled family (config and doc)

											
										
										
											2025-12-02 16:18:37 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								###### *HTTPS* Proxy or *SOCKS* Proxy
-												[tutorial v1.1_042] Copy HTTP manual proxy to HTTPS manual proxy (config and doc)

											
										
										
											2025-12-02 16:18:39 +01:00
 								> **🛈 Informations**
 								>
-												[tutorial v1.1_060] Family: a dynamic family (config and doc)

											
										
										
											2025-12-02 16:18:44 +01:00
+								> This family builds families dynamically.\
 								> **Path**:
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								> - firefox.manual.*https*_proxy
 								> - firefox.manual.*socks*_proxy\
-												[tutorial v1.1_098] A variable in avanced mode (config and doc)

											
										
										
											2025-12-02 16:19:11 +01:00
+								> `standard` *`hidden`*\
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								> **Hidden**: in HTTPS case if "[Also use this proxy for HTTPS](#firefox.manual.use_for_https)" is set to "true"\
-												[tutorial v1.1_060] Family: a dynamic family (config and doc)

											
										
										
											2025-12-02 16:18:44 +01:00
+								> **Identifiers**:
 								> - HTTPS
 								> - SOCKS
-												[tutorial v1.1_042] Copy HTTP manual proxy to HTTPS manual proxy (config and doc)

											
										
										
											2025-12-02 16:18:39 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								| Variable                                                                                                                                                                                                                                                                                                                        | Description                                                                                                                                                                                                                                                                                                  |
 								|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 								| **<a id="firefox.manual.:::identifier:::_proxy.address" name="firefox.manual.:::identifier:::_proxy.address">firefox.manual.*https*_proxy.address</a>**<br/>**firefox.manual.*socks*_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`          | *HTTPS* or *SOCKS* address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP<br/>**Default**: the value of the variable "[HTTP address](#firefox.manual.http_proxy.address)"                                                                                          |
 								| **<a id="firefox.manual.:::identifier:::_proxy.port" name="firefox.manual.:::identifier:::_proxy.port">firefox.manual.*https*_proxy.port</a>**<br/>**firefox.manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory`                            | *HTTPS* or *SOCKS* port.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;private ports (greater than 49152) are allowed<br/>**Default**: the value of the variable "[HTTP Port](#firefox.manual.http_proxy.port)" |
 								| **<a id="firefox.manual.:::identifier:::_proxy.version" name="firefox.manual.:::identifier:::_proxy.version">firefox.manual.*https*_proxy.version</a>**<br/>**firefox.manual.*socks*_proxy.version**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | SOCKS host version used by proxy.<br/>**Choices**: <br/>•&nbsp;v4<br/>•&nbsp;v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS"                                                                                                                                                             |
 								| Variable                                                                                                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 								|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 								| **<a id="firefox.auto" name="firefox.auto">firefox.auto</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`*                                                   | Automatic proxy configuration URL.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" hasn't the value "Automatic proxy configuration URL"                                                                                                                                                                                  |
 								| **<a id="firefox.no_proxy" name="firefox.no_proxy">firefox.no_proxy</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`disabled`* `unique`                             | Address for which proxy will be desactivated.<br/>Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can starts by a dot<br/>•&nbsp;the domain name can be a hostname<br/>•&nbsp;the domain name can be an IP<br/>•&nbsp;the domain name can be network in CIDR format<br/>**Examples**: <br/>•&nbsp;.mozilla.org<br/>•&nbsp;.net.nz<br/>•&nbsp;192.168.1.0/24<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" has the value "No proxy" |
 								| **<a id="firefox.prompt_authentication" name="firefox.prompt_authentication">firefox.prompt_authentication</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" has the value "No proxy"                                                                                                                                                                                                                                                                                                                                                                                   |
 								| **<a id="firefox.proxy_dns_socks5" name="firefox.proxy_dns_socks5">firefox.proxy_dns_socks5</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` *`disabled`*                | Use proxy DNS when using SOCKS v5.<br/>**Default**: false<br/>**Disabled**: if "[Configure Proxy Access to the Internet](#firefox.proxy_mode)" is not "Manual proxy configuration"<br/>or "[SOCKS host version used by proxy](#firefox.manual.:::identifier:::_proxy.version)" is "v4"                                                                                                                                                                                                                                                                                               |
 								##### DNS over HTTPS
 								> **🛈 Informations**
 								>
 								> **Path**: firefox.dns_over_https\
 								> `basic`
 								| Variable                                                                                                                                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                 |
 								|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 								| **<a id="firefox.dns_over_https.enable_dns_over_https" name="firefox.dns_over_https.enable_dns_over_https">firefox.dns_over_https.enable_dns_over_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.<br/>**Default**: false                                                                                                                                                                                                                                                                                                               |
 								| **<a id="firefox.dns_over_https.provider" name="firefox.dns_over_https.provider">firefox.dns_over_https.provider</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`*                            | Use Provider.<br/>**Choices**: <br/>•&nbsp;Cloudflare **← (default)**<br/>•&nbsp;NextDNS<br/>•&nbsp;Custom<br/>**Disabled**: when the variable "[Enable DNS over HTTPS](#firefox.dns_over_https.enable_dns_over_https)" has the value "false"                                                                                                               |
 								| **<a id="firefox.dns_over_https.custom_dns_url" name="firefox.dns_over_https.custom_dns_url">firefox.dns_over_https.custom_dns_url</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`*        | Custom DNS URL.<br/>**Validators**: <br/>•&nbsp;well-known ports (1 to 1023) are allowed<br/>•&nbsp;registred ports (1024 to 49151) are allowed<br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be a hostname<br/>•&nbsp;must starts with 'https://' only<br/>**Disabled**: if "[Use Provider](#firefox.dns_over_https.provider)" is not "Custom" |
-												[tutorial v1.1_050] A calculated default value (config and doc)

											
										
										
											2025-12-02 16:18:42 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								#### FoxyProxy
-												[tutorial v1.1_080] A conditional disabled variable with type web_address (config and doc)

											
										
										
											2025-12-02 16:18:53 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								> **🛈 Informations**
 								>
 								> **Path**: foxyproxy\
 								> `basic`
 								##### Proxy configuration
-												[tutorial v1.1_100] A boolean variable (config and doc)

											
										
										
											2025-12-02 16:19:13 +01:00
 								> **🛈 Informations**
 								>
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								> This family contains lists of variable blocks.\
 								> **Path**: foxyproxy.proxies\
-												[tutorial v1.1_102] A web_address variable  (config and doc)

											
										
										
											2025-12-02 16:19:17 +01:00
+								> `basic`
-												[tutorial v1.1_100] A boolean variable (config and doc)

											
										
										
											2025-12-02 16:19:13 +01:00
-												[tutorial v1.1_112] xxx (config and doc)

											
										
										
											2025-12-02 16:19:25 +01:00
+								| Variable                                                                                                                                                                                                                  | Description                                                                                                                 |
 								|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
 								| **<a id="foxyproxy.proxies.title" name="foxyproxy.proxies.title">foxyproxy.proxies.title</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique`      | Title or Description.                                                                                                       |
 								| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
 								### Let's generate the changelog
 								```shell
 								rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc --doc.contents changelog
 								```
-												[tutorial v1.1_112] xxx (config and doc)

											
										
										
											2025-12-02 16:19:25 +01:00
+								#### Modified variable
 								| Variable                                                                                                                                                                                                                             | Description                                                                                                                                       |
 								|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
 								| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` <ins>`auto modified`</ins> | Color.<br/>**Validator**: <ins>text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"</ins><br/>**Default**: <ins>random color value</ins> |
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								## User datas
 								### Example 1
 								#### config/01/config.yml
-												[tutorial v1.1_100] A boolean variable (config and doc)

											
										
										
											2025-12-02 16:19:13 +01:00
-												[tutorial v1.1_080] A conditional disabled variable with type web_address (config and doc)

											
										
										
											2025-12-02 16:18:53 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								```yml
 								---
 								```
 								#### Output
-												[tutorial v1.1_043] A conditional hidden family (config and doc)

											
										
										
											2025-12-02 16:18:41 +01:00
-												[tutorial v1.1_111] xxx (config and doc)

											
										
										
											2025-12-02 16:19:23 +01:00
+								```shell
 								rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u yaml -yf config/01/config.yml
 								```
 								<pre>╭──────────────────── Caption ─────────────────────╮
 								│ <span style="color: #5c5cff">Undocumented variable</span>              <span style="color: #ffd700">Default value</span> │
 								│ <span style="color: #ff0000">Undocumented but modified variable</span>               │
 								╰──────────────────────────────────────────────────╯
 								Variables:
 								<span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">Firefox</span>
 								<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
 								<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">DNS over HTTPS</span>
 								<span style="color: #5c5cff">┃   </span><span style="color: #5c5cff">    </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Enable DNS over HTTPS</span>: <span style="color: #ffd700">false</span>
 								<span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">FoxyProxy</span>
 								</pre>
-												[tutorial v1.1_112] xxx (config and doc)

											
										
										
											2025-12-02 16:19:25 +01:00
+								- [[tutorial v1.1_113] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_113/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_113~1..v1.1_113))