2024-11-02 14:58:10 +01:00
- [Summary ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md )
2024-11-02 14:59:01 +01:00
- [[tutorial 100] xxx](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))
2024-11-02 14:58:10 +01:00
2024-11-02 14:59:01 +01:00
# [tutorial 101] xxx
2024-11-02 14:58:10 +01:00
2024-11-02 14:59:01 +01:00
[View the diff ](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101 )
2024-11-02 14:58:10 +01:00
2024-11-02 14:58:09 +01:00
## Screenshot
< img src = "firefox.png" width = 50% height = 50% alt = "Firefox Proxy setting" / >
## Structure
2024-11-02 14:58:10 +01:00
### firefox/00-proxy.yml
```yml
---
2024-11-02 14:58:12 +01:00
proxy_mode:
2024-11-02 14:58:13 +01:00
description: Configure Proxy Access to the Internet
2024-11-02 14:58:14 +01:00
choices:
- No proxy
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL
2024-11-02 14:58:13 +01:00
default: No proxy
2024-11-02 14:58:10 +01:00
```
2024-11-02 14:58:16 +01:00
### firefox/10-manual.yml
2024-11-02 14:58:12 +01:00
```yml
---
2024-11-02 14:58:16 +01:00
manual:
description: Manual proxy configuration
2024-11-02 14:58:24 +01:00
disabled:
2024-11-02 14:58:57 +01:00
variable: _.proxy_mode
2024-11-02 14:58:24 +01:00
when_not: 'Manual proxy configuration'
2024-11-02 14:58:12 +01:00
2024-11-02 14:58:38 +01:00
http_proxy: # HTTP Proxy
2024-11-02 14:58:17 +01:00
2024-11-02 14:58:18 +01:00
address:
description: HTTP address
2024-11-02 14:58:20 +01:00
type: domainname
2024-11-02 14:58:21 +01:00
params:
allow_ip: true
2024-11-02 14:58:18 +01:00
2024-11-02 14:58:22 +01:00
port:
description: HTTP Port
type: port
default: 8080
2024-11-02 14:58:26 +01:00
```
### firefox/20-manual.yml
```yml
---
manual:
2024-11-02 14:58:39 +01:00
use_for_https: true # Also use this proxy for HTTPS
2024-11-02 14:58:26 +01:00
2024-11-02 14:58:33 +01:00
"{{ identifier }}_proxy":
description: "{{ identifier }} Proxy"
dynamic:
- HTTPS
- SOCKS
2024-11-02 14:58:30 +01:00
hidden:
2024-11-02 14:58:34 +01:00
jinja: |
2024-11-02 14:58:57 +01:00
{% if my_identifier == 'HTTPS' and _.use_for_https %}
2024-11-02 14:58:34 +01:00
HTTPS is same has HTTP
{% endif %}
2024-11-02 14:58:35 +01:00
params:
my_identifier:
type: identifier
2024-11-02 14:58:36 +01:00
description: |
in HTTPS case if "manual.use_for_https" is set to True
2024-11-02 14:58:28 +01:00
address:
2024-11-02 14:58:33 +01:00
description: "{{ identifier }} address"
2024-11-02 14:58:31 +01:00
default:
2024-11-02 14:58:58 +01:00
variable: __ .http_proxy.address
2024-11-02 14:58:28 +01:00
port:
2024-11-02 14:58:33 +01:00
description: "{{ identifier }} port"
2024-11-02 14:58:31 +01:00
default:
2024-11-02 14:58:58 +01:00
variable: __ .http_proxy.port
2024-11-02 14:58:28 +01:00
2024-11-02 14:58:37 +01:00
version:
description: SOCKS host version used by proxy
choices:
- v4
- v5
default: v5
disabled:
type: identifier
when: 'HTTPS'
2024-11-02 14:58:40 +01:00
```
### firefox/30-auto.yml
```yml
---
auto:
description: Automatic proxy configuration URL
type: web_address
2024-11-02 14:58:41 +01:00
disabled:
2024-11-02 14:58:57 +01:00
variable: _.proxy_mode
2024-11-02 14:58:41 +01:00
when_not: Automatic proxy configuration URL
2024-11-02 14:58:40 +01:00
2024-11-02 14:58:42 +01:00
```
### firefox/40-no_proxy.yml
```yml
---
no_proxy:
description: Address for which proxy will be desactivated
type: "domainname"
params:
allow_ip: true
allow_cidr_network: true
allow_without_dot: true
allow_startswith_dot: true
2024-11-02 14:58:43 +01:00
multi: true
2024-11-02 14:58:44 +01:00
mandatory: false
2024-11-02 14:58:42 +01:00
disabled:
2024-11-02 14:58:57 +01:00
variable: _.proxy_mode
2024-11-02 14:58:42 +01:00
when: No proxy
2024-11-02 14:58:46 +01:00
examples:
- .mozilla.org
- .net.nz
- 192.168.1.0/24
2024-11-02 14:58:47 +01:00
help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied
2024-11-02 14:58:42 +01:00
2024-11-02 14:58:48 +01:00
```
### firefox/50-prompt_authentication.yml
```yml
---
prompt_authentication:
description: Prompt for authentication if password is saved
default: true
disabled:
2024-11-02 14:58:57 +01:00
variable: _.proxy_mode
2024-11-02 14:58:48 +01:00
when: No proxy
2024-11-02 14:58:49 +01:00
```
### firefox/55-proxy_dns_socks5.yml
```yml
---
proxy_dns_socks5:
description: Use proxy DNS when using SOCKS v5
default: false
2024-11-02 14:58:52 +01:00
mode: advanced
2024-11-02 14:58:50 +01:00
disabled:
jinja: |
2024-11-02 14:58:57 +01:00
{% if _.manual.socks_proxy.version is propertyerror %}
2024-11-02 14:58:50 +01:00
the proxy mode is not manual
2024-11-02 14:58:57 +01:00
{% elif _.manual.socks_proxy.version == 'v4' %}
2024-11-02 14:58:50 +01:00
socks version is v4
{% endif %}
description: |
if "firefox.proxy_mode" is not "Manual proxy configuration"
or "firefox.manual.socks_proxy.version" is "v4"
2024-11-02 14:58:49 +01:00
2024-11-02 14:58:52 +01:00
```
### firefox/60-dns_over_https.yml
```yml
---
dns_over_https: # DNS over HTTPS
enable_dns_over_https: false # Enable DNS over HTTPS
2024-11-02 14:58:54 +01:00
provider:
description: Use Provider
choices:
- Cloudflare
- NextDNS
- Custom
default: Cloudflare
disabled:
2024-11-02 14:58:57 +01:00
variable: _.enable_dns_over_https
2024-11-02 14:58:54 +01:00
when: false
2024-11-02 14:58:55 +01:00
custom_dns_url:
description: Custom DNS URL
type: web_address
disabled:
jinja: |
2024-11-02 14:58:57 +01:00
{% if _.provider is propertyerror or _ .provider != 'Custom' %}
2024-11-02 14:58:55 +01:00
provider is not custom
{% endif %}
description: if "dns_over_https.provider" is not "Custom"
2024-11-02 14:58:56 +01:00
validators:
- jinja: |
{% if dns_over_https.custom_dns_url.startswith('http://') %}
only https is allowed
{% endif %}
description: must starts with 'https://' only
2024-11-02 14:58:55 +01:00
2024-11-02 14:58:59 +01:00
```
### firefox/empty.yml
```yml
2024-11-02 14:59:00 +01:00
```
### foxyproxy/00-foxyproxy.yml
```yml
---
2024-11-02 14:59:01 +01:00
proxies:
description: Proxy configuration
type: leadership
title:
description: Title or Description
mandatory: false
color:
description: Color
2024-11-02 14:59:00 +01:00
2024-11-02 14:58:12 +01:00
```
2024-11-02 14:58:16 +01:00
### Generated documentation
2024-11-02 14:58:12 +01:00
```console
2024-11-02 14:59:00 +01:00
foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc -do github
2024-11-02 14:58:12 +01:00
```
2024-11-02 14:59:00 +01:00
### Variables for "firefox"
2024-11-02 14:58:12 +01:00
2024-11-02 14:58:55 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2024-11-02 14:59:00 +01:00
| **firefox.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 |
2024-11-02 14:58:24 +01:00
#### Manual proxy configuration
2024-11-02 14:58:52 +01:00
`basic` _`disabled`_
2024-11-02 14:58:24 +01:00
2024-11-02 14:59:00 +01:00
**Disabled**: when the variable "firefox.proxy_mode" hasn't the value "Manual proxy configuration".
2024-11-02 14:58:24 +01:00
##### HTTP Proxy
2024-11-02 14:58:52 +01:00
`basic`
2024-11-02 14:58:28 +01:00
2024-11-02 14:58:55 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2024-11-02 14:59:00 +01:00
| **firefox.manual.http_proxy.address** < br /> [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP address.< br /> **Validator**: the domain name can be an IP |
| **firefox.manual.http_proxy.port** < br /> [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTP Port.< br /> **Default**: 8080 |
2024-11-02 14:58:52 +01:00
2024-11-02 14:58:55 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2024-11-02 14:59:00 +01:00
| **firefox.manual.use_for_https** < br /> [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Also use this proxy for HTTPS.< br /> **Default**: True |
2024-11-02 14:58:30 +01:00
2024-11-02 14:58:33 +01:00
##### "*HTTPS* Proxy" or "*SOCKS* Proxy"
2024-11-02 14:58:30 +01:00
2024-11-02 14:58:52 +01:00
`standard` _`hidden`_
2024-11-02 14:58:30 +01:00
2024-11-02 14:58:36 +01:00
**Hidden**: in HTTPS case if "manual.use_for_https" is set to True.
2024-11-02 14:58:30 +01:00
2024-11-02 14:58:33 +01:00
This family builds families dynamically.
**Identifiers**: < br / > - HTTPS< br / > - SOCKS
2024-11-02 14:58:55 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2024-11-02 14:59:00 +01:00
| **firefox.manual.https_proxy.address** or **firefox.manual.socks_proxy.address** < br /> [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "*HTTPS* address" or "*SOCKS* address".< br /> **Validator**: the domain name can be an IP< br /> **Default**: the value of the variable "firefox.manual.http_proxy.address". |
| **firefox.manual.https_proxy.port** or **firefox.manual.socks_proxy.port** < br /> [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | "*HTTPS* port" or "*SOCKS* port".< br /> **Default**: the value of the variable "firefox.manual.http_proxy.port". |
| **firefox.manual.https_proxy.version** or **firefox.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". |
2024-11-02 14:58:52 +01:00
2024-11-02 14:58:55 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2024-11-02 14:59:00 +01:00
| **firefox.auto** < br /> [`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` _`disabled`_ | Automatic proxy configuration URL.< br /> **Disabled**: when the variable "firefox.proxy_mode" hasn't the value "Automatic proxy configuration URL". |
| **firefox.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 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 "firefox.proxy_mode" has the value "No proxy". |
| **firefox.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**: when the variable "firefox.proxy_mode" has the value "No proxy". |
2024-11-02 14:58:52 +01:00
#### DNS over HTTPS
2024-11-02 14:58:40 +01:00
2024-11-02 14:58:55 +01:00
`basic`
2024-11-02 14:58:52 +01:00
2024-11-02 14:58:55 +01:00
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2024-11-02 14:59:00 +01:00
| **firefox.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 |
| **firefox.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**: when the variable "firefox.dns_over_https.enable_dns_over_https" has the value "False". |
| **firefox.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 /> **Validator**: must starts with 'https://' only.< br /> **Disabled**: if "dns_over_https.provider" is not "Custom". |
2024-11-02 14:59:01 +01:00
### Variables for "foxyproxy"
#### Proxy configuration
`basic`
This family contains lists of variable blocks.
| Variable | Description |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **foxyproxy.proxies.title** < br /> [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | Title or Description. |
| **foxyproxy.proxies.color** < br /> [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | Color. |
2024-11-02 14:59:00 +01:00
## User data
### Example 1
2024-11-02 14:58:18 +01:00
2024-11-02 14:59:00 +01:00
#### config/01/config.yaml
2024-11-02 14:58:18 +01:00
2024-11-02 14:58:26 +01:00
2024-11-02 14:59:00 +01:00
```yml
---
```
#### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u file -ff config/01/config.yaml
```
< pre > ╭────────────────────────── Caption ──────────────────────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
│ < span style = "color: #ffaf00 " > Unmodifiable variable</ span > │
╰─────────────────────────────────────────────────────────────╯
Variables:
< span style = "color: #5c5cff " > ┣━━ </ span > 📂 firefox
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 proxy_mode: < span style = "color: #ffd700 " > No proxy</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 dns_over_https
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 enable_dns_over_https: < span style = "color: #ffd700 " > False</ span >
2024-11-02 14:59:01 +01:00
< span style = "color: #5c5cff " > ┗━━ </ span > 📂 foxyproxy
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 proxies
2024-11-02 14:59:00 +01:00
< / pre >
### Example 2
#### config/02/config.yaml
2024-11-02 14:58:26 +01:00
2024-11-02 14:59:00 +01:00
```yml
---
foxyproxy:
proxies:
- title: My company
color: '#66cc66'
type: HTTP
address: proxy.company.net
```
#### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u file -ff config/02/config.yaml
```
< pre > 🛑 ERRORS
2024-11-02 14:59:01 +01:00
< span style = "color: #ff0000 " > ┣━━ </ span > unknown option "type" in optiondescription "foxyproxy.proxies" (Proxy configuration)
< span style = "color: #ff0000 " > ┗━━ </ span > unknown option "address" in optiondescription "foxyproxy.proxies" (Proxy configuration)
2024-11-02 14:59:00 +01:00
╭────────────────────────── Caption ──────────────────────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
│ < span style = "color: #ffaf00 " > Unmodifiable variable</ span > │
╰─────────────────────────────────────────────────────────────╯
Variables:
< span style = "color: #5c5cff " > ┣━━ </ span > 📂 firefox
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 proxy_mode: < span style = "color: #ffd700 " > No proxy</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 dns_over_https
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 enable_dns_over_https: < span style = "color: #ffd700 " > False</ span >
2024-11-02 14:59:01 +01:00
< span style = "color: #5c5cff " > ┗━━ </ span > 📂 foxyproxy
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 proxies
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 title
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 title: My company
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 color: #66cc66
2024-11-02 14:59:00 +01:00
< / pre >
### Example 3
#### config/03/config.yaml
```yml
---
firefox:
proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: http.proxy.net
foxyproxy:
proxies:
- title: My company
color: '#66cc66'
type: HTTP
- title: An other company
color: '#cc66cc'
type: SOCKS5
username: my_user
password: my_password
- title: WPAD
color: '#1166cc'
type: WPAD
url: http://wpad.proxy.net/wpad.dat
```
#### Output
```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u file -ff config/03/config.yaml
```
< pre > 🛑 ERRORS
2024-11-02 14:59:01 +01:00
< span style = "color: #ff0000 " > ┣━━ </ span > unknown option "url" in optiondescription "foxyproxy.proxies" (Proxy configuration)
< span style = "color: #ff0000 " > ┣━━ </ span > unknown option "username" in optiondescription "foxyproxy.proxies" (Proxy configuration)
< span style = "color: #ff0000 " > ┣━━ </ span > unknown option "type" in optiondescription "foxyproxy.proxies" (Proxy configuration)
< span style = "color: #ff0000 " > ┗━━ </ span > unknown option "password" in optiondescription "foxyproxy.proxies" (Proxy configuration)
2024-11-02 14:59:00 +01:00
╭────────────────────────── Caption ──────────────────────────╮
│ Variable < span style = "color: #ffd700 " > Default value</ span > │
│ < span style = "color: #5c5cff " > Undocumented variable</ span > Modified value │
│ < span style = "color: #ff0000 " > Undocumented but modified variable</ span > (< span style = "color: #00aa00 " > Original default value</ span > ) │
│ < span style = "color: #ffaf00 " > Unmodifiable variable</ span > │
╰─────────────────────────────────────────────────────────────╯
Variables:
< span style = "color: #5c5cff " > ┣━━ </ span > 📂 firefox
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 proxy_mode: Manual proxy configuration (< span style = "color: #00aa00 " > No proxy</ span > )
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📂 manual
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📂 http_proxy
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 address: http.proxy.net
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 port: < span style = "color: #ffd700 " > 8080</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 use_for_https: < span style = "color: #ffd700 " > True</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📂 < span style = "color: #ffaf00 " > https_proxy</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 < span style = "color: #ffaf00 " > address</ span > : < span style = "color: #ffd700 " > http.proxy.net</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 < span style = "color: #ffaf00 " > port</ span > : < span style = "color: #ffd700 " > 8080</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 socks_proxy
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 address: < span style = "color: #ffd700 " > http.proxy.net</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 port: < span style = "color: #ffd700 " > 8080</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 version: < span style = "color: #ffd700 " > v5</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 no_proxy :
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 prompt_authentication: < span style = "color: #ffd700 " > True</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 < span style = "color: #5c5cff " > proxy_dns_socks5</ span > : < span style = "color: #ffd700 " > False</ span >
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 dns_over_https
< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 enable_dns_over_https: < span style = "color: #ffd700 " > False</ span >
2024-11-02 14:59:01 +01:00
< span style = "color: #5c5cff " > ┗━━ </ span > 📂 foxyproxy
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 proxies
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📂 title
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 title: My company
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 color: #66cc66
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📂 title
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 title: An other company
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┃ </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 color: #cc66cc
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📂 title
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┣━━ </ span > 📓 title: WPAD
< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > </ span >< span style = "color: #5c5cff " > ┗━━ </ span > 📓 color: #1166cc
2024-11-02 14:59:00 +01:00
< / pre >
2024-11-02 14:59:01 +01:00
- [[tutorial 102] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102))