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 Proxy

> [!NOTE]
> 
> **Path**: manual.https_proxy\
> *`hidden`*\
> **Hidden**: when the variable "[Also use this proxy for HTTPS](#manual.use_for_https)" has the value "true".

| Variable                                                                                                                                                                                                       | Description                                                                                                                                                                                                                                                                               |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="manual.https_proxy.address" name="manual.https_proxy.address">manual.https_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<br/>**Default**: the value of the variable "[Proxy address](#manual.http_proxy.address)".                                                                                          |
| **<a id="manual.https_proxy.port" name="manual.https_proxy.port">manual.https_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**: the value of the variable "[Proxy port](#manual.http_proxy.port)". |

## SOCKS Proxy

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

| Variable                                                                                                                                                                                                       | Description                                                                                                                                                                                                                                                                               |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="manual.socks_proxy.address" name="manual.socks_proxy.address">manual.socks_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<br/>**Default**: the value of the variable "[Proxy address](#manual.http_proxy.address)".                                                                                          |
| **<a id="manual.socks_proxy.port" name="manual.socks_proxy.port">manual.socks_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**: the value of the variable "[Proxy port](#manual.http_proxy.port)". |
| **<a id="manual.socks_proxy.version" name="manual.socks_proxy.version">manual.socks_proxy.version</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`     | SOCKS host version used by proxy.<br/>**Choices**: <br/>•&nbsp;v4<br/>•&nbsp;v5 **← (default)**                                                                                                                                                                                           |
[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_081] Add a variable in a family with custom type (config and doc) 2026-04-18 21:47:37 +02:00			`## HTTPS Proxy`
[tutorial v1.1_053] A conditional hidden family (config and doc) 2026-04-18 21:47:02 +02:00
			`> [!NOTE]`
			`>`
[tutorial v1.1_081] Add a variable in a family with custom type (config and doc) 2026-04-18 21:47:37 +02:00			`> Path: manual.https_proxy\`
[tutorial v1.1_053] A conditional hidden family (config and doc) 2026-04-18 21:47:02 +02:00			> `hidden`\
[tutorial v1.1_081] Add a variable in a family with custom type (config and doc) 2026-04-18 21:47:37 +02:00			`> Hidden: when the variable "[Also use this proxy for HTTPS](#manual.use_for_https)" has the value "true".`

[tutorial v1.1_082] Redefine default value in custom type variable (config and doc) 2026-04-18 21:47:41 +02:00			`\| Variable \| Description \|`
			`\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|`
			\| <a id="manual.https_proxy.address" name="manual.https_proxy.address">manual.https_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<br/>Default: the value of the variable "[Proxy address](#manual.http_proxy.address)". \|
			\| <a id="manual.https_proxy.port" name="manual.https_proxy.port">manual.https_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: the value of the variable "[Proxy port](#manual.http_proxy.port)". \|
[tutorial v1.1_081] Add a variable in a family with custom type (config and doc) 2026-04-18 21:47:37 +02:00
			`## SOCKS Proxy`

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

[tutorial v1.1_082] Redefine default value in custom type variable (config and doc) 2026-04-18 21:47:41 +02:00			`\| Variable \| Description \|`
			`\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|`
			\| <a id="manual.socks_proxy.address" name="manual.socks_proxy.address">manual.socks_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<br/>Default: the value of the variable "[Proxy address](#manual.http_proxy.address)". \|
			\| <a id="manual.socks_proxy.port" name="manual.socks_proxy.port">manual.socks_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: the value of the variable "[Proxy port](#manual.http_proxy.port)". \|
			\| <a id="manual.socks_proxy.version" name="manual.socks_proxy.version">manual.socks_proxy.version</a><br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` \| SOCKS host version used by proxy.<br/>Choices: <br/>• v4<br/>• v5 ← (default) \|