[tutorial v1.1_120] xxx (config and doc)
This commit is contained in:
parent
b70fe2a52b
commit
98d3b5ff23
5 changed files with 57 additions and 225 deletions
240
README.md
240
README.md
|
|
@ -1,9 +1,9 @@
|
|||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||
- [[tutorial v1.1_113] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_113/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_113~1..v1.1_113))
|
||||
- [[tutorial v1.1_114] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_114~1..v1.1_114))
|
||||
|
||||
# [tutorial v1.1_114] xxx
|
||||
# [tutorial v1.1_120] xxx
|
||||
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_114~1..v1.1_114)
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_120~1..v1.1_120)
|
||||
|
||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx)
|
||||
|
||||
|
|
@ -31,7 +31,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
|
|||
Then switch to the tutorial page:
|
||||
|
||||
```shell
|
||||
git switch --detach v1.1_114
|
||||
git switch --detach v1.1_120
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
|
@ -39,22 +39,23 @@ git switch --detach v1.1_114
|
|||
|
||||
|
||||
<p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./">.</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/">firefox</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br/>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/empty.yml">empty.yml</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./foxyproxy/">foxyproxy</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./">.</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/">firefox</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br/>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/empty.yml">empty.yml</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./foxyproxy/">foxyproxy</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./foxyproxy/10-redefine.yml">10-redefine.yml</a><br/>
|
||||
<br/><br/></p>
|
||||
|
||||
Contents of the foxyproxy/00-foxyproxy.yml file
|
||||
Contents of the foxyproxy/10-redefine.yml file
|
||||
|
||||
```yml
|
||||
%YAML 1.2
|
||||
|
|
@ -62,139 +63,19 @@ Contents of the foxyproxy/00-foxyproxy.yml file
|
|||
version: 1.1
|
||||
|
||||
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}$
|
||||
default:
|
||||
jinja: >-
|
||||
#
|
||||
|
||||
{%- for i in range(6) -%}
|
||||
{{- '0123456789abcdef' | random -}}
|
||||
{%- endfor -%}
|
||||
description: random color value
|
||||
auto_save: true
|
||||
|
||||
address:
|
||||
description: IP address, DNS name, server name
|
||||
type: domainname
|
||||
params:
|
||||
allow_ip: true
|
||||
allow_without_dot: true
|
||||
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"
|
||||
disabled:
|
||||
jinja: |-
|
||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
||||
disabled
|
||||
{% endif %}
|
||||
description: |-
|
||||
if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5
|
||||
|
||||
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:
|
||||
jinja: |-
|
||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
||||
disabled
|
||||
{% endif %}
|
||||
description: |-
|
||||
if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5
|
||||
|
||||
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:
|
||||
jinja: |-
|
||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
||||
disabled
|
||||
{% endif %}
|
||||
description: |-
|
||||
if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5
|
||||
redefine: true
|
||||
mandatory: false
|
||||
|
||||
password:
|
||||
description: Password
|
||||
type: secret
|
||||
mandatory: false
|
||||
disabled:
|
||||
redefine: true
|
||||
hidden:
|
||||
jinja: |-
|
||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
||||
disabled
|
||||
{% if not _.username %}
|
||||
no username defined
|
||||
{% endif %}
|
||||
description: |-
|
||||
if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5
|
||||
|
||||
url:
|
||||
description: URL
|
||||
type: web_address
|
||||
default:
|
||||
jinja: >-
|
||||
{% if firefox.auto is not propertyerror %}
|
||||
{{ firefox.auto }}
|
||||
{% endif %}
|
||||
description: copy HTTP address if proxy is "Auto"
|
||||
disabled:
|
||||
jinja: |-
|
||||
{% if _.type not in ['PAC URL', 'WPAD'] %}
|
||||
proxy does not need url
|
||||
{% endif %}
|
||||
description: |-
|
||||
if type is not in:
|
||||
- PAC URL
|
||||
- WPAD
|
||||
description: if username is not defined
|
||||
...
|
||||
|
||||
```
|
||||
|
|
@ -293,65 +174,28 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basi
|
|||
> **Path**: foxyproxy.proxies\
|
||||
> `basic`
|
||||
|
||||
| Variable | Description |
|
||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="foxyproxy.proxies.title" name="foxyproxy.proxies.title">foxyproxy.proxies.title</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. |
|
||||
| **<a id="foxyproxy.proxies.type" name="foxyproxy.proxies.type">foxyproxy.proxies.type</a>**<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)** |
|
||||
| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
|
||||
| **<a id="foxyproxy.proxies.address" name="foxyproxy.proxies.address">foxyproxy.proxies.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.<br/>**Validators**: <br/>• type domainname<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 |
|
||||
| **<a id="foxyproxy.proxies.port" name="foxyproxy.proxies.port">foxyproxy.proxies.port</a>**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• private ports (greater than 49152) are allowed<br/>**Default**: copy HTTP port if proxy is not "Manual"<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
||||
| **<a id="foxyproxy.proxies.username" name="foxyproxy.proxies.username">foxyproxy.proxies.username</a>**<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 |
|
||||
| **<a id="foxyproxy.proxies.password" name="foxyproxy.proxies.password">foxyproxy.proxies.password</a>**<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 |
|
||||
| **<a id="foxyproxy.proxies.url" name="foxyproxy.proxies.url">foxyproxy.proxies.url</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• type domainname<br/>• the domain name can be a hostname<br/>**Default**: copy HTTP address if proxy is "Auto"<br/>**Disabled**: if type is not in:<br/>- PAC URL<br/>- WPAD |
|
||||
| Variable | Description |
|
||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="foxyproxy.proxies.title" name="foxyproxy.proxies.title">foxyproxy.proxies.title</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. |
|
||||
| **<a id="foxyproxy.proxies.type" name="foxyproxy.proxies.type">foxyproxy.proxies.type</a>**<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)** |
|
||||
| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
|
||||
| **<a id="foxyproxy.proxies.address" name="foxyproxy.proxies.address">foxyproxy.proxies.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.<br/>**Validators**: <br/>• type domainname<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 |
|
||||
| **<a id="foxyproxy.proxies.port" name="foxyproxy.proxies.port">foxyproxy.proxies.port</a>**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• private ports (greater than 49152) are allowed<br/>**Default**: copy HTTP port if proxy is not "Manual"<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
||||
| **<a id="foxyproxy.proxies.username" name="foxyproxy.proxies.username">foxyproxy.proxies.username</a>**<br/>[`UNIX user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Username.<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
||||
| **<a id="foxyproxy.proxies.password" name="foxyproxy.proxies.password">foxyproxy.proxies.password</a>**<br/>[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* *`disabled`* | Password.<br/>**Hidden**: if username is not defined<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
||||
| **<a id="foxyproxy.proxies.url" name="foxyproxy.proxies.url">foxyproxy.proxies.url</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• type domainname<br/>• the domain name can be a hostname<br/>**Default**: copy HTTP address if proxy is "Auto"<br/>**Disabled**: if type is not in:<br/>- PAC URL<br/>- WPAD |
|
||||
|
||||
### Let's generate the changelog
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc --doc.contents changelog
|
||||
```
|
||||
#### New variables
|
||||
#### Modified variables
|
||||
|
||||
| Variable | Description |
|
||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="foxyproxy.proxies.address" name="foxyproxy.proxies.address">foxyproxy.proxies.address</a>**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.<br/>**Validators**: <br/>• type domainname<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 |
|
||||
| **<a id="foxyproxy.proxies.port" name="foxyproxy.proxies.port">foxyproxy.proxies.port</a>**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• private ports (greater than 49152) are allowed<br/>**Default**: copy HTTP port if proxy is not "Manual"<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
||||
| **<a id="foxyproxy.proxies.username" name="foxyproxy.proxies.username">foxyproxy.proxies.username</a>**<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 |
|
||||
| **<a id="foxyproxy.proxies.password" name="foxyproxy.proxies.password">foxyproxy.proxies.password</a>**<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 |
|
||||
| **<a id="foxyproxy.proxies.url" name="foxyproxy.proxies.url">foxyproxy.proxies.url</a>**<br/>[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.<br/>**Validators**: <br/>• well-known ports (1 to 1023) are allowed<br/>• registred ports (1024 to 49151) are allowed<br/>• type domainname<br/>• the domain name can be a hostname<br/>**Default**: copy HTTP address if proxy is "Auto"<br/>**Disabled**: if type is not in:<br/>- PAC URL<br/>- WPAD |
|
||||
|
||||
#### Modified variable
|
||||
|
||||
| Variable | Description |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
|
||||
| Variable | Description |
|
||||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
|
||||
| **<a id="foxyproxy.proxies.username" name="foxyproxy.proxies.username">foxyproxy.proxies.username</a>**<br/>~~`mandatory`~~ [`UNIX user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Username.<br/>**Mandatory**: ~~if a password is set~~<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
||||
| **<a id="foxyproxy.proxies.password" name="foxyproxy.proxies.password">foxyproxy.proxies.password</a>**<br/>[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` <ins>*`hidden`*</ins> *`disabled`* | Password.<br/>**Hidden**: <ins>if username is not defined</ins><br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
||||
|
||||
|
||||
## User datas
|
||||
|
||||
### Example 1
|
||||
|
||||
#### config/01/config.yml
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
```
|
||||
#### Output
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u yaml -yf config/01/config.yml
|
||||
```
|
||||
<pre>╭──────────────────── Caption ─────────────────────╮
|
||||
│ <span style="color: #5c5cff">Undocumented variable</span> <span style="color: #ffd700">Default value</span> │
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> │
|
||||
╰──────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">Firefox</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">DNS over HTTPS</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Enable DNS over HTTPS</span>: <span style="color: #ffd700">false</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">FoxyProxy</span>
|
||||
</pre>
|
||||
|
||||
|
||||
- [[tutorial v1.1_120] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_120~1..v1.1_120))
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u yaml -yf config/01/config.yml
|
||||
|
|
@ -1 +0,0 @@
|
|||
---
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
<pre>╭──────────────────── Caption ─────────────────────╮
|
||||
│ <span style="color: #5c5cff">Undocumented variable</span> <span style="color: #ffd700">Default value</span> │
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> │
|
||||
╰──────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">Firefox</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">DNS over HTTPS</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Enable DNS over HTTPS</span>: <span style="color: #ffd700">false</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">FoxyProxy</span>
|
||||
</pre>
|
||||
29
tree.html
29
tree.html
|
|
@ -25,22 +25,23 @@
|
|||
</head>
|
||||
<body>
|
||||
<h1>Directory Tree</h1><p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./">.</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/">firefox</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/10-manual.yml">10-manual.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/20-manual.yml">20-manual.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/30-auto.yml">30-auto.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./firefox/empty.yml">empty.yml</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./foxyproxy/">foxyproxy</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_114/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./">.</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/">firefox</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/10-manual.yml">10-manual.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/20-manual.yml">20-manual.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/30-auto.yml">30-auto.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./firefox/empty.yml">empty.yml</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./foxyproxy/">foxyproxy</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/./foxyproxy/10-redefine.yml">10-redefine.yml</a><br>
|
||||
<br><br><p>
|
||||
|
||||
3 directories, 10 files
|
||||
3 directories, 11 files
|
||||
|
||||
</p>
|
||||
<hr>
|
||||
|
|
|
|||
Loading…
Reference in a new issue