[tutorial 100] xxx (config and doc)
This commit is contained in:
parent
2b56a7889a
commit
c560ae22d0
7 changed files with 256 additions and 20 deletions
182
README.md
182
README.md
|
@ -1,9 +1,9 @@
|
||||||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||||
- [[tutorial 091] Variable in parent family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_091/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091))
|
- [[tutorial 092] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_092/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_092~1..v1.1_092))
|
||||||
|
|
||||||
# [tutorial 092] Namespace
|
# [tutorial 100] xxx
|
||||||
|
|
||||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_092~1..v1.1_092)
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100)
|
||||||
|
|
||||||
|
|
||||||
## Screenshot
|
## Screenshot
|
||||||
|
@ -216,23 +216,30 @@ dns_over_https: # DNS over HTTPS
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
|
|
||||||
|
```
|
||||||
|
### foxyproxy/00-foxyproxy.yml
|
||||||
|
|
||||||
|
|
||||||
|
```yml
|
||||||
|
---
|
||||||
|
|
||||||
```
|
```
|
||||||
### Generated documentation
|
### Generated documentation
|
||||||
|
|
||||||
```console
|
```console
|
||||||
foo@bar:~$ rougail -v 1.1 -m firefox/ --modes_level basic standard advanced -o doc -do github
|
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
|
### Variables for "firefox"
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **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 |
|
| **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
|
#### Manual proxy configuration
|
||||||
|
|
||||||
`basic` _`disabled`_
|
`basic` _`disabled`_
|
||||||
|
|
||||||
**Disabled**: when the variable "proxy_mode" hasn't the value "Manual proxy configuration".
|
**Disabled**: when the variable "firefox.proxy_mode" hasn't the value "Manual proxy configuration".
|
||||||
|
|
||||||
##### HTTP Proxy
|
##### HTTP Proxy
|
||||||
|
|
||||||
|
@ -240,12 +247,12 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ --modes_level basic standard advanced -o d
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **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.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 |
|
||||||
| **manual.http_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTP Port.<br/>**Default**: 8080 |
|
| **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 |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **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 |
|
| **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"
|
##### "*HTTPS* Proxy" or "*SOCKS* Proxy"
|
||||||
|
|
||||||
|
@ -260,15 +267,15 @@ This family builds families dynamically.
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **manual.https_proxy.address** or **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 "manual.http_proxy.address". |
|
| **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". |
|
||||||
| **manual.https_proxy.port** or **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 "manual.http_proxy.port". |
|
| **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". |
|
||||||
| **manual.https_proxy.version** or **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". |
|
| **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 |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **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 "proxy_mode" hasn't the value "Automatic proxy configuration URL". |
|
| **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". |
|
||||||
| **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 "proxy_mode" has the value "No proxy". |
|
| **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". |
|
||||||
| **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 "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
|
#### DNS over HTTPS
|
||||||
|
|
||||||
|
@ -276,11 +283,146 @@ This family builds families dynamically.
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **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.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 |
|
||||||
| **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 "dns_over_https.enable_dns_over_https" has the value "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". |
|
||||||
| **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". |
|
| **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". |
|
||||||
|
|
||||||
|
|
||||||
|
## User data
|
||||||
|
|
||||||
|
### Example 1
|
||||||
|
|
||||||
|
#### config/01/config.yaml
|
||||||
|
|
||||||
|
|
||||||
- [[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))
|
```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>📂 <span style="color: #5c5cff">foxyproxy</span>
|
||||||
|
</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>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┗━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
╭────────────────────────── 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>📂 <span style="color: #5c5cff">foxyproxy</span>
|
||||||
|
</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>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┗━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
╭────────────────────────── 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>📂 <span style="color: #5c5cff">foxyproxy</span>
|
||||||
|
</pre>
|
||||||
|
|
||||||
|
|
||||||
|
- [[tutorial 101] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_101/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101))
|
||||||
|
|
1
config/01/config.yaml
Normal file
1
config/01/config.yaml
Normal file
|
@ -0,0 +1 @@
|
||||||
|
---
|
13
config/01/output_ro.html
Normal file
13
config/01/output_ro.html
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
<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>📂 <span style="color: #5c5cff">foxyproxy</span>
|
||||||
|
</pre>
|
7
config/02/config.yaml
Normal file
7
config/02/config.yaml
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
foxyproxy:
|
||||||
|
proxies:
|
||||||
|
- title: My company
|
||||||
|
color: '#66cc66'
|
||||||
|
type: HTTP
|
||||||
|
address: proxy.company.net
|
18
config/02/output_ro.html
Normal file
18
config/02/output_ro.html
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
<pre>🛑 ERRORS
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┗━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
╭────────────────────────── 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>📂 <span style="color: #5c5cff">foxyproxy</span>
|
||||||
|
</pre>
|
20
config/03/config.yaml
Normal file
20
config/03/config.yaml
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
---
|
||||||
|
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
|
35
config/03/output_ro.html
Normal file
35
config/03/output_ro.html
Normal file
|
@ -0,0 +1,35 @@
|
||||||
|
<pre>🛑 ERRORS
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┣━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
<span style="color: #ff0000">┗━━ </span>unknown option "proxies" in optiondescription "foxyproxy" (FoxyProxy)
|
||||||
|
╭────────────────────────── 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>📂 <span style="color: #5c5cff">foxyproxy</span>
|
||||||
|
</pre>
|
Loading…
Reference in a new issue