561 lines
67 KiB
Markdown
561 lines
67 KiB
Markdown
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
|
- [[tutorial 103] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103))
|
|
|
|
# [tutorial 104] xxx
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_104~1..v1.1_104)
|
|
|
|
|
|
## Screenshot
|
|
|
|
|
|
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
|
|
|
|
|
## Structure
|
|
|
|
|
|
### firefox/00-proxy.yml
|
|
|
|
|
|
```yml
|
|
---
|
|
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
|
|
|
|
```
|
|
### firefox/10-manual.yml
|
|
|
|
|
|
```yml
|
|
---
|
|
manual:
|
|
description: Manual proxy configuration
|
|
disabled:
|
|
variable: _.proxy_mode
|
|
when_not: 'Manual proxy configuration'
|
|
|
|
http_proxy: # HTTP Proxy
|
|
|
|
address:
|
|
description: HTTP address
|
|
type: domainname
|
|
params:
|
|
allow_ip: true
|
|
|
|
port:
|
|
description: HTTP Port
|
|
type: port
|
|
default: 8080
|
|
|
|
```
|
|
### firefox/20-manual.yml
|
|
|
|
|
|
```yml
|
|
---
|
|
manual:
|
|
|
|
use_for_https: true # Also use this proxy for HTTPS
|
|
|
|
"{{ identifier }}_proxy":
|
|
description: "{{ identifier }} Proxy"
|
|
dynamic:
|
|
- HTTPS
|
|
- SOCKS
|
|
hidden:
|
|
jinja: |
|
|
{% if my_identifier == 'HTTPS' and _.use_for_https %}
|
|
HTTPS is same has HTTP
|
|
{% endif %}
|
|
params:
|
|
my_identifier:
|
|
type: identifier
|
|
description: |
|
|
in HTTPS case if "manual.use_for_https" is set to True
|
|
|
|
address:
|
|
description: "{{ identifier }} address"
|
|
default:
|
|
variable: __.http_proxy.address
|
|
|
|
port:
|
|
description: "{{ identifier }} port"
|
|
default:
|
|
variable: __.http_proxy.port
|
|
|
|
version:
|
|
description: SOCKS host version used by proxy
|
|
choices:
|
|
- v4
|
|
- v5
|
|
default: v5
|
|
disabled:
|
|
type: identifier
|
|
when: 'HTTPS'
|
|
|
|
```
|
|
### firefox/30-auto.yml
|
|
|
|
|
|
```yml
|
|
---
|
|
auto:
|
|
description: Automatic proxy configuration URL
|
|
type: web_address
|
|
disabled:
|
|
variable: _.proxy_mode
|
|
when_not: Automatic proxy configuration URL
|
|
|
|
```
|
|
### 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
|
|
multi: true
|
|
mandatory: false
|
|
disabled:
|
|
variable: _.proxy_mode
|
|
when: No proxy
|
|
examples:
|
|
- .mozilla.org
|
|
- .net.nz
|
|
- 192.168.1.0/24
|
|
help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied
|
|
|
|
```
|
|
### firefox/50-prompt_authentication.yml
|
|
|
|
|
|
```yml
|
|
---
|
|
prompt_authentication:
|
|
description: Prompt for authentication if password is saved
|
|
default: true
|
|
disabled:
|
|
variable: _.proxy_mode
|
|
when: No proxy
|
|
|
|
```
|
|
### firefox/55-proxy_dns_socks5.yml
|
|
|
|
|
|
```yml
|
|
---
|
|
proxy_dns_socks5:
|
|
description: Use proxy DNS when using SOCKS v5
|
|
default: false
|
|
mode: advanced
|
|
disabled:
|
|
jinja: |
|
|
{% if _.manual.socks_proxy.version is propertyerror %}
|
|
the proxy mode is not manual
|
|
{% elif _.manual.socks_proxy.version == 'v4' %}
|
|
socks version is v4
|
|
{% endif %}
|
|
description: |
|
|
if "firefox.proxy_mode" is not "Manual proxy configuration"
|
|
or "firefox.manual.socks_proxy.version" is "v4"
|
|
|
|
```
|
|
### firefox/60-dns_over_https.yml
|
|
|
|
|
|
```yml
|
|
---
|
|
dns_over_https: # DNS over HTTPS
|
|
|
|
enable_dns_over_https: false # Enable DNS over HTTPS
|
|
|
|
provider:
|
|
description: Use Provider
|
|
choices:
|
|
- Cloudflare
|
|
- NextDNS
|
|
- Custom
|
|
default: Cloudflare
|
|
disabled:
|
|
variable: _.enable_dns_over_https
|
|
when: false
|
|
|
|
custom_dns_url:
|
|
description: Custom DNS URL
|
|
type: web_address
|
|
disabled:
|
|
jinja: |
|
|
{% if _.provider is propertyerror or _.provider != 'Custom' %}
|
|
provider is not custom
|
|
{% endif %}
|
|
description: if "dns_over_https.provider" is not "Custom"
|
|
validators:
|
|
- jinja: |
|
|
{% if dns_over_https.custom_dns_url.startswith('http://') %}
|
|
only https is allowed
|
|
{% endif %}
|
|
description: must starts with 'https://' only
|
|
|
|
```
|
|
### firefox/empty.yml
|
|
|
|
|
|
```yml
|
|
|
|
```
|
|
### foxyproxy/00-foxyproxy.yml
|
|
|
|
|
|
```yml
|
|
---
|
|
proxies:
|
|
description: Proxy configuration
|
|
_type: leadership
|
|
|
|
title:
|
|
description: Title or Description
|
|
mandatory: false
|
|
|
|
type:
|
|
description: Proxy Type
|
|
choices:
|
|
- HTTP
|
|
- HTTPS/SSL
|
|
- SOCKS4
|
|
- SOCKS5
|
|
- PAC URL
|
|
- WPAD
|
|
- System (use system settings)
|
|
- Direct (no proxy)
|
|
default: Direct (no proxy)
|
|
|
|
color:
|
|
description: Color
|
|
regexp: "^#(?:[0-9a-f]{3}){1,2}$"
|
|
auto_save: true
|
|
default:
|
|
jinja: |
|
|
#
|
|
{%- for i in range(6) -%}
|
|
{{- '0123456789abcdef' | random -}}
|
|
{%- endfor -%}
|
|
description: random color value
|
|
|
|
address:
|
|
description: IP address, DNS name, server name
|
|
type: domainname
|
|
params:
|
|
allow_ip: true
|
|
allow_without_dot: true
|
|
disabled: &needs_address
|
|
jinja: |
|
|
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
|
disabled
|
|
{% endif %}
|
|
description: |
|
|
if type not in:
|
|
- HTTP
|
|
- HTTPS/SSL
|
|
- SOCKS4
|
|
- SOCKS5
|
|
default:
|
|
jinja: |
|
|
{% if firefox.manual.http_proxy.address is not propertyerror %}
|
|
{{ firefox.manual.http_proxy.address }}
|
|
{% endif %}
|
|
description: copy HTTP address if proxy is not "Manual"
|
|
|
|
port:
|
|
description: Port
|
|
type: port
|
|
default:
|
|
jinja: |
|
|
{% if firefox.manual.http_proxy.port is not propertyerror %}
|
|
{{ firefox.manual.http_proxy.port }}
|
|
{% endif %}
|
|
description: copy HTTP port if proxy is not "Manual"
|
|
disabled: *needs_address
|
|
|
|
username:
|
|
description: Username
|
|
type: unix_user
|
|
mandatory:
|
|
jinja: |
|
|
{% if _.password is not propertyerror and _.password %}
|
|
username is mandatory
|
|
{% endif %}
|
|
description: if a password is set
|
|
disabled: *needs_address
|
|
|
|
password:
|
|
description: Password
|
|
type: secret
|
|
mandatory: false
|
|
disabled: *needs_address
|
|
|
|
url:
|
|
description: URL
|
|
type: web_address
|
|
disabled:
|
|
jinja: |
|
|
{% if _.type not in ['PAC URL', 'WPAD'] %}
|
|
proxy does not need url
|
|
{% endif %}
|
|
description: |
|
|
if type is not in:
|
|
- PAC URL
|
|
- WPAD
|
|
default:
|
|
jinja: |
|
|
{% if firefox.auto is not propertyerror %}
|
|
{{ firefox.auto }}
|
|
{% endif %}
|
|
description: copy HTTP address if proxy is "Auto"
|
|
|
|
```
|
|
### Generated documentation
|
|
|
|
```console
|
|
foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc -do github
|
|
```
|
|
### Variables for "firefox"
|
|
|
|
| Variable | Description |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **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 |
|
|
|
|
#### Manual proxy configuration
|
|
|
|
`basic` _`disabled`_
|
|
|
|
**Disabled**: when the variable "firefox.proxy_mode" hasn't the value "Manual proxy configuration".
|
|
|
|
##### HTTP Proxy
|
|
|
|
`basic`
|
|
|
|
| Variable | Description |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **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 |
|
|
|
|
| Variable | Description |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **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 |
|
|
|
|
##### "*HTTPS* Proxy" or "*SOCKS* Proxy"
|
|
|
|
`standard` _`hidden`_
|
|
|
|
**Hidden**: in HTTPS case if "manual.use_for_https" is set to True.
|
|
|
|
|
|
This family builds families dynamically.
|
|
|
|
**Identifiers**: <br/>- HTTPS<br/>- SOCKS
|
|
|
|
| Variable | Description |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **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". |
|
|
|
|
| Variable | Description |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **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". |
|
|
|
|
#### DNS over HTTPS
|
|
|
|
`basic`
|
|
|
|
| Variable | Description |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **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". |
|
|
|
|
|
|
### 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.type**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy 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) ← (default) |
|
|
| **foxyproxy.proxies.color**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Default**: random color value. |
|
|
| **foxyproxy.proxies.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | IP address, DNS name, server name.<br/>**Validators**:<br/>- the domain name can be a hostname<br/>- the domain name can be an IP<br/>**Default**: copy HTTP address if proxy is not "Manual".<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5. |
|
|
| **foxyproxy.proxies.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | Port.<br/>**Default**: copy HTTP port if proxy is not "Manual".<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5. |
|
|
| **foxyproxy.proxies.username**<br/>[`unix_user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`mandatory`_ _`disabled`_ | Username.<br/>**Mandatory**: if a password is set.<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5. |
|
|
| **foxyproxy.proxies.password**<br/>[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` _`disabled`_ | Password.<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5. |
|
|
| **foxyproxy.proxies.url**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` _`disabled`_ | URL.<br/>**Default**: copy HTTP address if proxy is "Auto".<br/>**Disabled**: if type is not in:<br/>- PAC URL<br/>- WPAD. |
|
|
|
|
|
|
## User data
|
|
|
|
### Example 1
|
|
|
|
#### config/01/config.yaml
|
|
|
|
|
|
```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>
|
|
<span style="color: #5c5cff">┗━━ </span>📂 foxyproxy
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 proxies
|
|
</pre>
|
|
### Example 2
|
|
|
|
#### config/02/config.yaml
|
|
|
|
|
|
```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
|
|
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
|
|
<span style="color: #ff0000">┗━━ </span> - foxyproxy.proxies.port (Port)
|
|
</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
|
|
<span style="color: #ff0000">┣━━ </span>cannot access to option "foxyproxy.proxies.password" (Password) because has property "disabled"
|
|
<span style="color: #ff0000">┃ </span>(disabled)
|
|
<span style="color: #ff0000">┣━━ </span>cannot access to option "foxyproxy.proxies.url" (URL) because has property "disabled" (proxy does not
|
|
<span style="color: #ff0000">┃ </span>need url)
|
|
<span style="color: #ff0000">┗━━ </span>cannot access to option "foxyproxy.proxies.username" (Username) because has property "disabled"
|
|
<span style="color: #ff0000"> </span>(disabled)
|
|
╭────────────────────────── 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>
|
|
<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>📓 type: HTTP (<span style="color: #00aa00">Direct (no proxy)</span>)
|
|
<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><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>📓 username: None
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 password: None
|
|
<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>📓 type: SOCKS5 (<span style="color: #00aa00">Direct (no proxy)</span>)
|
|
<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><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>📓 username: my_user
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 password: **********
|
|
<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>📓 type: WPAD (<span style="color: #00aa00">Direct (no proxy)</span>)
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 color: #1166cc
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 url: http://wpad.proxy.net/wpad.dat
|
|
</pre>
|
|
|
|
|
|
- [[tutorial 110] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110))
|