| **<aid="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 |
| **<aid="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 |
| **<aid="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) `basic` `mandatory` | HTTP address.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
| **<aid="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) `standard` `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 |
| **<aid="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 |
| **<aid="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) `standard` `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
##### *HTTPS* Proxy or *SOCKS* Proxy
@ -113,35 +115,45 @@ rougail -m firefox/ -o doc
> **Path**:
> - manual.*https*_proxy
> - manual.*socks*_proxy\
> *`hidden`*\
> `standard`*`hidden`*\
> **Hidden**: in HTTPS case if "[Also use this proxy for HTTPS](#manual.use_for_https)" is set to "true"\
| **<aid="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 "[HTTP address](#manual.http_proxy.address)" |
| **<aid="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 "[HTTP Port](#manual.http_proxy.port)" |
| **<aid="manual.:::identifier:::_proxy.version"name="manual.:::identifier:::_proxy.version">manual.*https*_proxy.version</a>**<br/>**manual.*socks*_proxy.version**<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" |
| **<aid="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) `standard` `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 "[HTTP address](#manual.http_proxy.address)" |
| **<aid="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) `standard` `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 "[HTTP Port](#manual.http_proxy.port)" |
| **<aid="manual.:::identifier:::_proxy.version"name="manual.:::identifier:::_proxy.version">manual.*https*_proxy.version</a>**<br/>**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/>• v4<br/>• v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS" |
| **<aid="auto"name="auto">auto</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• type domainname<br/>• the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" |
| **<aid="no_proxy"name="no_proxy">no_proxy</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple`*`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/>• type domainname<br/>• the domain name can starts by a dot<br/>• the domain name can be a hostname<br/>• the domain name can be an IP<br/>• the domain name can be network in CIDR format<br/>**Examples**: <br/>• .mozilla.org<br/>• .net.nz<br/>• 192.168.1.0/24<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
| **<aid="prompt_authentication"name="prompt_authentication">prompt_authentication</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
| **<aid="proxy_dns_socks5"name="proxy_dns_socks5">proxy_dns_socks5</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.<br/>**Default**: false<br/>**Disabled**: if "firefox.proxy_mode" is not "Manual proxy configuration"<br/>or "firefox.manual.socks_proxy.version" is "v4" |
| **<aid="auto"name="auto">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/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• type domainname<br/>• the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" |
| **<aid="no_proxy"name="no_proxy">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/>• type domainname<br/>• the domain name can starts by a dot<br/>• the domain name can be a hostname<br/>• the domain name can be an IP<br/>• the domain name can be network in CIDR format<br/>**Examples**: <br/>• .mozilla.org<br/>• .net.nz<br/>• 192.168.1.0/24<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
| **<aid="prompt_authentication"name="prompt_authentication">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](#proxy_mode)" has the value "No proxy" |
| **<aid="proxy_dns_socks5"name="proxy_dns_socks5">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 "firefox.proxy_mode" is not "Manual proxy configuration"<br/>or "firefox.manual.socks_proxy.version" is "v4" |
| **<aid="proxy_dns_socks5"name="proxy_dns_socks5">proxy_dns_socks5</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`<ins>*`disabled`*</ins> | Use proxy DNS when using SOCKS v5.<br/>**Default**: false<br/>**Disabled**: <ins>if "firefox.proxy_mode" is not "Manual proxy configuration"<br/>or "firefox.manual.socks_proxy.version" is "v4"</ins> |
| **<aid="proxy_mode"name="proxy_mode">proxy_mode</a>**<br/>~~`(None, [], ['standard'])`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard``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 |
| **<aid="manual.http_proxy.address"name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>~~`(None, [], ['basic'])`~~ [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic``mandatory` | HTTP address.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
| **<aid="manual.http_proxy.port"name="manual.http_proxy.port">manual.http_proxy.port</a>**<br/>~~`(None, [], ['standard'])`~~ [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard``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 |
| **<aid="manual.use_for_https"name="manual.use_for_https">manual.use_for_https</a>**<br/>~~`(None, [], ['standard'])`~~ [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard``mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
| **<aid="manual.:::identifier:::_proxy.address"name="manual.:::identifier:::_proxy.address">manual.*https*_proxy.address</a>**<br/>**manual.*socks*_proxy.address**<br/>~~`(None, [], ['standard'])`~~ [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard``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 "[HTTP address](#manual.http_proxy.address)" |
| **<aid="manual.:::identifier:::_proxy.port"name="manual.:::identifier:::_proxy.port">manual.*https*_proxy.port</a>**<br/>**manual.*socks*_proxy.port**<br/>~~`(None, [], ['standard'])`~~ [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard``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 "[HTTP Port](#manual.http_proxy.port)" |
| **<aid="manual.:::identifier:::_proxy.version"name="manual.:::identifier:::_proxy.version">manual.*https*_proxy.version</a>**<br/>**manual.*socks*_proxy.version**<br/>~~`(None, [], ['standard'])`~~ [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard``mandatory`*`disabled`* | SOCKS host version used by proxy.<br/>**Choices**: <br/>• v4<br/>• v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS" |
| **<aid="auto"name="auto">auto</a>**<br/>~~`(None, [], ['basic'])`~~ [`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic``mandatory`*`disabled`* | Automatic proxy configuration URL.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• type domainname<br/>• the domain name can be a hostname<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" |
| **<aid="no_proxy"name="no_proxy">no_proxy</a>**<br/>~~`(None, [], ['standard'])`~~ [`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/>• type domainname<br/>• the domain name can starts by a dot<br/>• the domain name can be a hostname<br/>• the domain name can be an IP<br/>• the domain name can be network in CIDR format<br/>**Examples**: <br/>• .mozilla.org<br/>• .net.nz<br/>• 192.168.1.0/24<br/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
| **<aid="prompt_authentication"name="prompt_authentication">prompt_authentication</a>**<br/>~~`(None, [], ['standard'])`~~ [`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](#proxy_mode)" has the value "No proxy" |
| **<aid="proxy_dns_socks5"name="proxy_dns_socks5">proxy_dns_socks5</a>**<br/>~~`(None, [], ['advanced'])`~~ [`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 "firefox.proxy_mode" is not "Manual proxy configuration"<br/>or "firefox.manual.socks_proxy.version" is "v4" |
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff">┣━━ </span>📓 <spanstyle="color: #ff0000">Also use this proxy for HTTPS</span>: <spanstyle="color: #ffd700">true</span>
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff"></span><spanstyle="color: #5c5cff">┗━━ </span>📓 <spanstyle="color: #ff0000">SOCKS host version used by proxy</span>: <spanstyle="color: #ffd700">v5</span>
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff">┣━━ </span>📓 <spanstyle="color: #ff0000">Also use this proxy for HTTPS</span>: <spanstyle="color: #ffd700">true</span>
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff"></span><spanstyle="color: #5c5cff">┗━━ </span>📓 <spanstyle="color: #ff0000">SOCKS host version used by proxy</span>: <spanstyle="color: #ffd700">v5</span>
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff">┣━━ </span>📓 <spanstyle="color: #ff0000">Also use this proxy for HTTPS</span>: <spanstyle="color: #ffd700">true</span>
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff"></span><spanstyle="color: #5c5cff">┗━━ </span>📓 <spanstyle="color: #ff0000">SOCKS host version used by proxy</span>: <spanstyle="color: #00aa00">v4</span> ◀ loaded from the YAML file
@ -288,4 +300,4 @@ Variables:
</pre>
- [[tutorial v1.1_098] A variable in avanced mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_098~1..v1.1_098))
- [[tutorial v1.1_100] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100))
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff">┣━━ </span>📓 <spanstyle="color: #ff0000">Also use this proxy for HTTPS</span>: <spanstyle="color: #ffd700">true</span>
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff"></span><spanstyle="color: #5c5cff">┗━━ </span>📓 <spanstyle="color: #ff0000">SOCKS host version used by proxy</span>: <spanstyle="color: #ffd700">v5</span>
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff">┣━━ </span>📓 <spanstyle="color: #ff0000">Also use this proxy for HTTPS</span>: <spanstyle="color: #ffd700">true</span>
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff"></span><spanstyle="color: #5c5cff">┗━━ </span>📓 <spanstyle="color: #ff0000">SOCKS host version used by proxy</span>: <spanstyle="color: #ffd700">v5</span>
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff">┣━━ </span>📓 <spanstyle="color: #ff0000">Also use this proxy for HTTPS</span>: <spanstyle="color: #ffd700">true</span>
<spanstyle="color: #5c5cff">┃ </span><spanstyle="color: #5c5cff"></span><spanstyle="color: #5c5cff">┗━━ </span>📓 <spanstyle="color: #ff0000">SOCKS host version used by proxy</span>: <spanstyle="color: #00aa00">v4</span> ◀ loaded from the YAML file
