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

## 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` | HTTP 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`                | 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="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

| 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` | HTTPS address.<br/>**Validators**: <br/>•&nbsp;type domainname<br/>•&nbsp;the domain name can be an IP                                                                                                                      |
| **<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`                | HTTPS 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_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_022] Putting a variable inside of a family or a sub family (config and doc) 2026-04-18 21:46:16 +02:00
			`# Manual proxy configuration`

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

			`## HTTP Proxy`

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

[tutorial v1.1_032] A variable with type "port" (config and doc) 2026-04-18 21:46:31 +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` \| HTTP 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` \| HTTP 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_033] A variable with type "boolean" (config and doc) 2026-04-18 21:46:35 +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_040] HTTPS family (config and doc) 2026-04-18 21:46:39 +02:00
			`## HTTPS Proxy`

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

			`\| 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` \| HTTPS address.<br/>Validators: <br/>• type domainname<br/>• the domain name can be an IP \|
			\| <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` \| HTTPS 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 \|