2024-07-21 11:27:47 +02:00
---
gitea: none
include_toc: true
---
# Tutorial description files
2024-07-21 11:26:02 +02:00
2024-07-21 11:27:47 +02:00
## all/proxy/20-auto.yml
```yaml
version: 1.1
auto:
description: Automatic proxy configuration URL
type: web_address
disabled:
type: jinja
jinja: |
{% if _.proxy_mode != 'Automatic proxy configuration URL' %}
the proxy mode is not automatic
{% endif %}
description: if proxy_mode is not "automatic proxy configuration URL"
```
## all/proxy/50-proxy_dns_socks5.yml
```yaml
version: 1.1
proxy_dns_socks5:
mode: advanced
description: Use proxy DNS when using SOCKS v5
default: false
disabled:
type: jinja
jinja: |
{% if _.proxy_mode == 'No proxy' %}
the proxy mode is no proxy
{% elif socks_version is undefined or socks_version == 'v4' %}
socks version is v4
{% endif %}
params:
socks_version:
type: variable
variable: _.manual.socks_proxy.version
propertyerror: false
```
## all/proxy/00-proxy.yml
```yaml
version: 1.1
proxy_mode:
description: Configure Proxy Access to the Internet
choices:
- No proxy
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL
default: No proxy
```
## all/proxy/40-prompt_authentication.yml
```yaml
version: 1.1
prompt_authentication:
description: Prompt for authentication if password is saved
default: true
disabled:
type: jinja
jinja: |
{% if _.proxy_mode == 'No proxy' %}
proxy mode is no proxy
{% endif %}
description: if proxy is "no proxy"
```
## all/proxy/60-dns_over_https.yml
```yaml
version: 1.1
dns_over_https:
description: DNS over HTTPS
enable_dns_over_https: false # Enable DNS over HTTPS
provider:
description: Use Provider
choices:
- Cloudflare
- NextDNS
- Custom
default: Cloudflare
disabled:
type: jinja
jinja: |
{% if not _.enable_dns_over_https %}
Enable DNS over HTTPS is False
{% endif %}
description: if enable_dns_over_https is not False
custom_dns_url:
description: Custom DNS URL
type: web_address
disabled:
type: jinja
jinja: |
{% if provider is not defined or provider != 'Custom' %}
provider is not custom
{% endif %}
params:
provider:
type: variable
variable: _.provider
propertyerror: false
description: if provider is Custom
validators:
- type: jinja
jinja: |
{% if _.custom_dns_url.startswith('http://') %}
only https is allowed
{% endif %}
description: custom_dns_url must starts with 'https://' only
```
## all/proxy/10-manual.yml
```yaml
version: 1.1
manual:
description: Manual proxy configuration
disabled:
type: jinja
jinja: |
{% if _.proxy_mode != 'Manual proxy configuration' %}
the proxy mode is not manual
{% endif %}
description: if the value of "proxy.proxy_mode" is not "Manual proxy configuration"
http_proxy: # HTTP Proxy
address:
description: HTTP address
type: domainname
port:
description: HTTP Port
type: port
default: '8080'
use_for_https: true # Also use this proxy for HTTPS
'{{ suffix }}_proxy':
description: '{{ suffix }} Proxy'
type: dynamic
dynamic:
- HTTPS
- SOCKS
hidden:
type: jinja
jinja: |
{% if suffix == 'HTTPS' and _.use_for_https %}
HTTPS is same has HTTP
{% endif %}
params:
suffix:
type: suffix
description: |
if HTTPS is same has HTTP
address:
description: address
type: domainname
default:
type: variable
variable: __ .http_proxy.address
port:
description: Port
type: port
default:
type: variable
variable: __ .http_proxy.port
version:
description: SOCKS host version used by proxy
choices:
- v4
- v5
default: v5
disabled:
type: jinja
jinja: |
{% if suffix == 'HTTPS' %}
if HTTPS
{% endif %}
params:
suffix:
type: suffix
description: |
if not SOCKS
```
## all/proxy/30-no_proxy.yml
```yaml
version: 1.1
no_proxy:
description: Address for which proxy will be desactivated
type: domainname
multi: true
mandatory: false
params:
allow_ip: true
allow_cidr_network: true
allow_without_dot: true
allow_startswith_dot: true
disabled:
type: jinja
jinja: |
{% if _.proxy_mode == 'No proxy' %}
proxy mode is no proxy
{% endif %}
description: if proxy is "no proxy"
test:
- .mozilla.org
- .net.nz
- 192.168.1.0/24
help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied
```
## all/foxyproxy/10-redefine.yml
```yaml
version: 1.1
proxies:
username:
redefine: true
mandatory: false
password:
redefine: true
hidden:
type: jinja
jinja: |
{% if not _.username %}
no username defined
{% endif %}
description: if username is not defined
```
## all/foxyproxy/00-foxyproxy.yml
```yaml
version: 1.1
proxies:
description: Proxy configuration
_type: leadership
title:
description: Title or Description
multi: true
color:
description: Color
type:
description: Type
type: choice
choices:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5
- PAC URL
- WPAD
- System (use system settings)
- Direct (no proxy)
default: Direct (no proxy)
address:
description: IP address, DNS name, server name
multi: true
disabled:
type: jinja
jinja: |
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
proxy does not need address
{% endif %}
description: & needs_address |
if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5
default:
type: jinja
jinja: |
{% if firefox_address is not undefined %}
{{ firefox_address }}
{% endif %}
params:
firefox_address:
type: variable
variable: proxy.manual.http_proxy.address
propertyerror: false
description: copy HTTP address if proxy is not "Manual"
port:
description: Port
type: port
default:
type: jinja
jinja: |
{% if firefox_port is not undefined %}
{{ firefox_port }}
{% endif %}
params:
firefox_port:
type: variable
variable: proxy.manual.http_proxy.port
propertyerror: false
description: copy HTTP port if proxy is not "Manual"
disabled:
type: jinja
jinja: |
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
proxy does not need port
{% endif %}
description: *needs_address
username:
description: Username
type: unix_user
mandatory:
type: jinja
jinja: |
{% if _.password %}
username is mandatory
{% endif %}
disabled:
type: jinja
jinja: |
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
proxy does not need username
{% endif %}
description: *needs_address
password:
description: Password
type: secret
disabled:
type: jinja
jinja: |
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
proxy does not need password
{% endif %}
description: *needs_address
url:
description: URL
type: web_address
disabled:
type: jinja
jinja: |
{% if _.type not in ['PAC URL', 'WPAD'] %}
proxy does not need url
{% endif %}
description: |
if type is not in:
- PAC URL
- WPAD
```
# Generated documentation
## Variables for "proxy"
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy.proxy_mode** < br /> [`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 |
### Manual proxy configuration
`basic` _`disabled`_
**Disabled**: i< br / > f< br / > < br / > t< br / > h< br / > e< br / > < br / > v< br / > a< br / > l< br / > u< br / > e< br / > < br / > o< br / > f< br / > < br / > "< br / > p< br / > r< br / > o< br / > x< br / > y< br / > .< br / > p< br / > r< br / > o< br / > x< br / > y< br / > _< br / > m< br / > o< br / > d< br / > e< br / > "< br / > < br / > i< br / > s< br / > < br / > n< br / > o< br / > t< br / > < br / > "< br / > M< br / > a< br / > n< br / > u< br / > a< br / > l< br / > < br / > p< br / > r< br / > o< br / > x< br / > y< br / > < br / > c< br / > o< br / > n< br / > f< br / > i< br / > g< br / > u< br / > r< br / > a< br / > t< br / > i< br / > o< br / > n< br / > "
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy.auto** < br /> [`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | Automatic proxy configuration URL.< br /> **Disabled**: i< br /> f< br /> < br /> p< br /> r< br /> o< br /> x< br /> y< br /> _< br /> m< br /> o< br /> d< br /> e< br /> < br /> i< br /> s< br /> < br /> n< br /> o< br /> t< br /> < br /> "< br /> a< br /> u< br /> t< br /> o< br /> m< br /> a< br /> t< br /> i< br /> c< br /> < br /> p< br /> r< br /> o< br /> x< br /> y< br /> < br /> c< br /> o< br /> n< br /> f< br /> i< br /> g< br /> u< br /> r< br /> a< br /> t< br /> i< br /> o< br /> n< br /> < br /> U< br /> R< br /> L< br /> " |
| **proxy.no_proxy** < br /> [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`disabled`_ `unique` `multiple` | Address for which proxy will be desactivated.< br /> Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.< br /> **Validators**:< br /> - the domain name can starts by a dot< br /> - the domain name can be only 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**: i< br /> f< br /> < br /> p< br /> r< br /> o< br /> x< br /> y< br /> < br /> i< br /> s< br /> < br /> "< br /> n< br /> o< br /> < br /> p< br /> r< br /> o< br /> x< br /> y< br /> " |
| **proxy.prompt_authentication** < 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**: i< br /> f< br /> < br /> p< br /> r< br /> o< br /> x< br /> y< br /> < br /> i< br /> s< br /> < br /> "< br /> n< br /> o< br /> < br /> p< br /> r< br /> o< br /> x< br /> y< br /> " |
### DNS over HTTPS
`basic`
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy.dns_over_https.enable_dns_over_https** < br /> [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.< br /> **Default**: False |
| **proxy.dns_over_https.provider** < br /> [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | Use Provider.< br /> **Choices**: < br /> - Cloudflare ← (default)< br /> - NextDNS< br /> - Custom< br /> **Disabled**: i< br /> f< br /> < br /> e< br /> n< br /> a< br /> b< br /> l< br /> e< br /> _< br /> d< br /> n< br /> s< br /> _< br /> o< br /> v< br /> e< br /> r< br /> _< br /> h< br /> t< br /> t< br /> p< br /> s< br /> < br /> i< br /> s< br /> < br /> n< br /> o< br /> t< br /> < br /> F< br /> a< br /> l< br /> s< br /> e |
| **proxy.dns_over_https.custom_dns_url** < br /> [`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | Custom DNS URL.< br /> **Validators**:< br /> - c< br /> u< br /> s< br /> t< br /> o< br /> m< br /> _< br /> d< br /> n< br /> s< br /> _< br /> u< br /> r< br /> l< br />
< br / > m< br / > u< br / > s< br / > t< br / > < br / > s< br / > t< br / > a< br / > r< br / > t< br / > s< br / > < br / > w< br / > i< br / > t< br / > h< br / >
< br / > '< br / > h< br / > t< br / > t< br / > p< br / > s< br / > :< br / > /< br / > /< br / > '< br / > < br / > o< br / > n< br / > l< br / > y< br / > **Disabled**: i< br / > f< br / > < br / > p< br / > r< br / > o< br / > v< br / > i< br / > d< br / > e< br / > r< br / > < br / > i< br / > s< br / > < br / > C< br / > u< br / > s< br / > t< br / > o< br / > m |
## Variables for "foxyproxy"
### Proxy configuration
`basic`
Cette famille contient des listes de bloc de variables.
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **foxyproxy.proxies.title** < br /> [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `unique` `multiple` | Title or Description. |
| **foxyproxy.proxies.color** < br /> [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Color. |
| **foxyproxy.proxies.type** < br /> [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Type.< br /> **Choices**: < br /> - HTTP< br /> - HTTPS/SSL< br /> - SOCKS4< br /> - SOCKS5< br /> - PAC URL< br /> - WPAD< br /> - System (use system settings)< br /> - Direct (no proxy) |
| **foxyproxy.proxies.address** < br /> [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ `multiple` | IP address, DNS name, server name.< br /> **Default**: c< br /> o< br /> p< br /> y< br /> < br /> H< br /> T< br /> T< br /> P< br /> < br /> a< br /> d< br /> d< br /> r< br /> e< br /> s< br /> s< br /> < br /> i< br /> f< br /> < br /> p< br /> r< br /> o< br /> x< br /> y< br /> < br /> i< br /> s< br /> < br /> n< br /> o< br /> t< br /> < br /> "< br /> M< br /> a< br /> n< br /> u< br /> a< br /> l< br /> "< br /> **Disabled**: i< br /> f< br /> < br /> t< br /> y< br /> p< br /> e< br /> < br /> n< br /> o< br /> t< br /> < br /> i< br /> n< br /> :< br />
< br / > -< br / > < br / > H< br / > T< br / > T< br / > P< br / >
< br / > -< br / > < br / > H< br / > T< br / > T< br / > P< br / > S< br / > /< br / > S< br / > S< br / > L< br / >
< br / > -< br / > < br / > S< br / > O< br / > C< br / > K< br / > S< br / > 4< br / >
< br / > -< br / > < br / > S< br / > O< br / > C< br / > K< br / > S< br / > 5< br / >
|
| **foxyproxy.proxies.port** < br /> [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | Port.< br /> **Default**: c< br /> o< br /> p< br /> y< br /> < br /> H< br /> T< br /> T< br /> P< br /> < br /> p< br /> o< br /> r< br /> t< br /> < br /> i< br /> f< br /> < br /> p< br /> r< br /> o< br /> x< br /> y< br /> < br /> i< br /> s< br /> < br /> n< br /> o< br /> t< br /> < br /> "< br /> M< br /> a< br /> n< br /> u< br /> a< br /> l< br /> "< br /> **Disabled**: i< br /> f< br /> < br /> t< br /> y< br /> p< br /> e< br /> < br /> n< br /> o< br /> t< br /> < br /> i< br /> n< br /> :< br />
< br / > -< br / > < br / > H< br / > T< br / > T< br / > P< br / >
< br / > -< br / > < br / > H< br / > T< br / > T< br / > P< br / > S< br / > /< br / > S< br / > S< br / > L< br / >
< br / > -< br / > < br / > S< br / > O< br / > C< br / > K< br / > S< br / > 4< br / >
< br / > -< br / > < br / > S< br / > O< br / > C< br / > K< br / > S< br / > 5< br / >
|
| **foxyproxy.proxies.username** < br /> [`unix_user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`disabled`_ | Username.< br /> **Disabled**: i< br /> f< br /> < br /> t< br /> y< br /> p< br /> e< br /> < br /> n< br /> o< br /> t< br /> < br /> i< br /> n< br /> :< br />
< br / > -< br / > < br / > H< br / > T< br / > T< br / > P< br / >
< br / > -< br / > < br / > H< br / > T< br / > T< br / > P< br / > S< br / > /< br / > S< br / > S< br / > L< br / >
< br / > -< br / > < br / > S< br / > O< br / > C< br / > K< br / > S< br / > 4< br / >
< br / > -< br / > < br / > S< br / > O< br / > C< br / > K< br / > S< br / > 5< br / >
|
| **foxyproxy.proxies.password** < br /> [`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`hidden`_ _`disabled`_ | Password.< br /> **Hidden**: i< br /> f< br /> < br /> u< br /> s< br /> e< br /> r< br /> n< br /> a< br /> m< br /> e< br /> < br /> i< br /> s< br /> < br /> n< br /> o< br /> t< br /> < br /> d< br /> e< br /> f< br /> i< br /> n< br /> e< br /> d< br /> **Disabled**: i< br /> f< br /> < br /> t< br /> y< br /> p< br /> e< br /> < br /> n< br /> o< br /> t< br /> < br /> i< br /> n< br /> :< br />
< br / > -< br / > < br / > H< br / > T< br / > T< br / > P< br / >
< br / > -< br / > < br / > H< br / > T< br / > T< br / > P< br / > S< br / > /< br / > S< br / > S< br / > L< br / >
< br / > -< br / > < br / > S< br / > O< br / > C< br / > K< br / > S< br / > 4< br / >
< br / > -< br / > < br / > S< br / > O< br / > C< br / > K< br / > S< br / > 5< br / >
|
| **foxyproxy.proxies.url** < br /> [`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | URL.< br /> **Disabled**: i< br /> f< br /> < br /> t< br /> y< br /> p< br /> e< br /> < br /> i< br /> s< br /> < br /> n< br /> o< br /> t< br /> < br /> i< br /> n< br /> :< br />
< br / > -< br / > < br / > P< br / > A< br / > C< br / > < br / > U< br / > R< br / > L< br / >
< br / > -< br / > < br / > W< br / > P< br / > A< br / > D< br / >
|
## Exemple avec les variables obligatoires non renseignées
```yaml
proxy:
auto: https://example.net
dns_over_https:
custom_dns_url: https://example.net
```
## Exemple avec tous les variables modifiables
```yaml
proxy:
proxy_mode: No proxy
auto: https://example.net
no_proxy:
- .mozilla.org
- .net.nz
- 192.168.1.0/24
prompt_authentication: true
dns_over_https:
enable_dns_over_https: false
provider: Cloudflare
custom_dns_url: https://example.net
foxyproxy:
proxies:
- title: xxx
color: xxx
type: Direct (no proxy)
address:
- None
port: '8080'
username: xxx
password: xxx
url: https://example.net
```
