rougail-tutorials/DOCUMENTATION.md

| Variable                                                                                                                                                   | Description                                                                                                                                                                                                                                                                  |
|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `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

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

## HTTP Proxy

> [!NOTE]
> 
> **Path**: manual.http_proxy

| Variable                                                                                                                                                                                                    | Description                                                                                                                                                                                                                 |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP                                                                                                                      |
| **<a id="manual.http_proxy.port" name="manual.http_proxy.port">manual.http_proxy.port</a>**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`                | Proxy 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="manual.use_for_https" name="manual.use_for_https">manual.use_for_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |

## *HTTPS* or *SOCKS* Proxy

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

| Variable                                                                                                                                                                                                                                                                    | Description                                                                                                                                                                                                                                                                                            |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="manual.:::identifier:::_proxy.address" name="manual.:::identifier:::_proxy.address">manual.*https*_proxy.address</a>**<br/>**manual.*socks*_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `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 "[Proxy address](#manual.http_proxy.address)".                                                                                          |
| **<a id="manual.:::identifier:::_proxy.port" name="manual.:::identifier:::_proxy.port">manual.*https*_proxy.port</a>**<br/>**manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `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 "[Proxy port](#manual.http_proxy.port)". |
| **<a id="manual.:::identifier:::_proxy.version" name="manual.:::identifier:::_proxy.version">manual.*socks*_proxy.version</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`*                             | SOCKS host version used by proxy.<br/>**Choices**: <br/>•&nbsp;v4<br/>•&nbsp;v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS".                                                                                                                                                      |
[tutorial v1.1_010] A variable with a list of possible values (config and doc) 2026-04-18 21:46:02 +02:00			`\| Variable \| Description \|`
			`\|------------------------------------------------------------------------------------------------------------------------------------------------------------\|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|`
			\| <a id="proxy_mode" name="proxy_mode">proxy_mode</a><br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` \| Configure Proxy Access to the Internet.<br/>Choices: <br/>• No proxy ← (default)<br/>• Auto-detect proxy settings for this network<br/>• Use system proxy settings<br/>• Manual proxy configuration<br/>• Automatic proxy configuration URL \|
[tutorial v1.1_051] A conditional disabled family (config and doc) 2026-04-18 21:46:53 +02:00
			`# Manual proxy configuration`

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

			`## HTTP Proxy`

			`> [!NOTE]`
			`>`
			`> Path: manual.http_proxy`

[tutorial v1.1_080] Proxy custom type (config and doc) 2026-04-18 21:47:33 +02:00			`\| Variable \| Description \|`
			`\|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|`
			\| <a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a><br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` \| Proxy address.<br/>Validators: <br/>• type domainname<br/>• the domain name can be an IP \|
			\| <a id="manual.http_proxy.port" name="manual.http_proxy.port">manual.http_proxy.port</a><br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` \| Proxy port.<br/>Validators: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• private ports (greater than 49152) are allowed<br/>Default: 8080 \|
[tutorial v1.1_051] A conditional disabled family (config and doc) 2026-04-18 21:46:53 +02:00
			`\| Variable \| Description \|`
			`\|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|------------------------------------------------------\|`
			\| <a id="manual.use_for_https" name="manual.use_for_https">manual.use_for_https</a><br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` \| Also use this proxy for HTTPS.<br/>Default: true \|
[tutorial v1.1_053] A conditional hidden family (config and doc) 2026-04-18 21:47:02 +02:00
[tutorial v1.1_060] A dynamically built family (config and doc) 2026-04-18 21:47:06 +02:00			`## HTTPS or SOCKS Proxy`
[tutorial v1.1_053] A conditional hidden family (config and doc) 2026-04-18 21:47:02 +02:00
			`> [!NOTE]`
			`>`
[tutorial v1.1_060] A dynamically built family (config and doc) 2026-04-18 21:47:06 +02:00			`> This family builds families dynamically.\`
			`> Path: > - manual.https_proxy`
			`> - manual.socks_proxy\`
[tutorial v1.1_053] A conditional hidden family (config and doc) 2026-04-18 21:47:02 +02:00			> `hidden`\
[tutorial v1.1_071] Jinja with a description (config and doc) 2026-04-18 21:47:20 +02:00			`> Hidden: in HTTPS case if "[Also use this proxy for HTTPS](#manual.use_for_https)" is set to "true".\`
[tutorial v1.1_060] A dynamically built family (config and doc) 2026-04-18 21:47:06 +02:00			`> Identifiers: > - HTTPS`
			`> - SOCKS`

[tutorial v1.1_080] Proxy custom type (config and doc) 2026-04-18 21:47:33 +02:00			\| Variable \| Description \|
			\|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
			\| *<a id="manual.:::identifier:::_proxy.address" name="manual.:::identifier:::_proxy.address">manual.https_proxy.address</a><br/>manual.socks_proxy.address<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` \| HTTPS* or SOCKS address.<br/>Validators: <br/>• type domainname<br/>• the domain name can be an IP<br/>Default: the value of the variable "[Proxy address](#manual.http_proxy.address)". \|
			\| *<a id="manual.:::identifier:::_proxy.port" name="manual.:::identifier:::_proxy.port">manual.https_proxy.port</a><br/>manual.socks_proxy.port<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` \| HTTPS* or SOCKS port.<br/>Validators: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• private ports (greater than 49152) are allowed<br/>Default: the value of the variable "[Proxy port](#manual.http_proxy.port)". \|
			\| *<a id="manual.:::identifier:::_proxy.version" name="manual.:::identifier:::_proxy.version">manual.socks_proxy.version</a><br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` `disabled`* \| SOCKS host version used by proxy.<br/>Choices: <br/>• v4<br/>• v5 ← (default)<br/>Disabled: when the identifier is "HTTPS". \|