[tutorial v1.1_201] redefines the behavior to password mandatory if the user is defined (config and doc)
This commit is contained in:
parent
0831d8746f
commit
19c5f331f7
5 changed files with 59 additions and 224 deletions
239
README.md
239
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 v1.1_190] Various variables](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_200~1..v1.1_200))
|
- [[tutorial v1.1_200] Username is mandatory if a password is set](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_201~1..v1.1_201))
|
||||||
|
|
||||||
# [tutorial v1.1_200] Username is mandatory if a password is set
|
# [tutorial v1.1_201] redefines the behavior to password mandatory if the user is defined
|
||||||
|
|
||||||
[Read the tutorial "Username is mandatory if a password is set" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#username-is-mandatory-if-a-password-is-set)
|
[Read the tutorial "redefines the behavior to password mandatory if the user is defined" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#redefines-the-behavior-to-password-mandatory-if-the-user-is-defined)
|
||||||
|
|
||||||
|
|
||||||
## Screenshot
|
## Screenshot
|
||||||
|
|
@ -29,7 +29,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
|
||||||
Then switch to the tutorial page:
|
Then switch to the tutorial page:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
git switch --detach v1.1_200
|
git switch --detach v1.1_201
|
||||||
```
|
```
|
||||||
|
|
||||||
## Structure
|
## Structure
|
||||||
|
|
@ -37,24 +37,25 @@ git switch --detach v1.1_200
|
||||||
|
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./">.</a><br/>
|
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./">.</a><br/>
|
||||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./firefox/">firefox</a><br/>
|
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./firefox/">firefox</a><br/>
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./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_201/./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_200/./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_201/./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_200/./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_201/./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_200/./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_201/./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_200/./foxyproxy/">foxyproxy</a><br/>
|
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./foxyproxy/">foxyproxy</a><br/>
|
||||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./types/">types</a><br/>
|
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./foxyproxy/10-redefine.yml">10-redefine.yml</a><br/>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./types/proxy/">proxy</a><br/>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./types/">types</a><br/>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./types/proxy/00_type.yml">00_type.yml</a><br/>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./types/proxy/">proxy</a><br/>
|
||||||
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./types/proxy/00_type.yml">00_type.yml</a><br/>
|
||||||
<br/><br/></p>
|
<br/><br/></p>
|
||||||
|
|
||||||
Contents of the foxyproxy/00-foxyproxy.yml file
|
Contents of the foxyproxy/10-redefine.yml file
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
%YAML 1.2
|
%YAML 1.2
|
||||||
|
|
@ -62,132 +63,18 @@ Contents of the foxyproxy/00-foxyproxy.yml file
|
||||||
version: 1.1
|
version: 1.1
|
||||||
|
|
||||||
proxies:
|
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: |-
|
|
||||||
{{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }}
|
|
||||||
return_type: boolean
|
|
||||||
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: |-
|
|
||||||
{{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }}
|
|
||||||
return_type: boolean
|
|
||||||
description: |-
|
|
||||||
if type not in:
|
|
||||||
- HTTP
|
|
||||||
- HTTPS/SSL
|
|
||||||
- SOCKS4
|
|
||||||
- SOCKS5
|
|
||||||
|
|
||||||
username:
|
username:
|
||||||
description: Username
|
redefine: true
|
||||||
type: unix_user
|
mandatory: false
|
||||||
mandatory:
|
|
||||||
jinja: |-
|
|
||||||
{{ _.password is not propertyerror and _.password }}
|
|
||||||
description: if a password is set
|
|
||||||
return_type: boolean
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
|
||||||
{{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }}
|
|
||||||
return_type: boolean
|
|
||||||
description: |-
|
|
||||||
if type not in:
|
|
||||||
- HTTP
|
|
||||||
- HTTPS/SSL
|
|
||||||
- SOCKS4
|
|
||||||
- SOCKS5
|
|
||||||
|
|
||||||
password:
|
password:
|
||||||
description: Password
|
redefine: true
|
||||||
type: secret
|
hidden:
|
||||||
mandatory: false
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
jinja: |-
|
||||||
{{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }}
|
{{ not _.username }}
|
||||||
return_type: boolean
|
return_type: boolean
|
||||||
description: |-
|
description: if username is empty
|
||||||
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: |-
|
|
||||||
{{ _.type not in ['PAC URL', 'WPAD'] }}
|
|
||||||
return_type: boolean
|
|
||||||
description: |-
|
|
||||||
if type is not in:
|
|
||||||
- PAC URL
|
|
||||||
- WPAD
|
|
||||||
...
|
...
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -296,16 +183,16 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox
|
||||||
> **Path**: foxyproxy.proxies\
|
> **Path**: foxyproxy.proxies\
|
||||||
> `basic`
|
> `basic`
|
||||||
|
|
||||||
| Variable | Description |
|
| 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.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.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.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.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.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.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` *`disabled`* | Password.<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 empty<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 |
|
| **<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 |
|
||||||
|
|
||||||
|
|
||||||
***
|
***
|
||||||
|
|
@ -314,53 +201,13 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox
|
||||||
```shell
|
```shell
|
||||||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml
|
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml
|
||||||
```
|
```
|
||||||
#### New variables
|
#### Modified variables
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
|
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **<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.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.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.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 empty</ins><br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
||||||
#### 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 |
|
|
||||||
|
|
||||||
|
|
||||||
***
|
***
|
||||||
## User datas
|
|
||||||
|
|
||||||
### Example 1
|
|
||||||
|
|
||||||
#### config/01/config.yml
|
|
||||||
|
|
||||||
|
|
||||||
```yml
|
|
||||||
---
|
|
||||||
```
|
|
||||||
|
|
||||||
***
|
|
||||||
#### Output
|
|
||||||
|
|
||||||
```shell
|
|
||||||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml
|
|
||||||
```
|
|
||||||
> [!NOTE]
|
|
||||||
>
|
|
||||||
> **Caption:**
|
|
||||||
> - Variable
|
|
||||||
> - <span style="color: #B8860B">Default value</span>
|
|
||||||
|
|
||||||
Variables:
|
|
||||||
- :open_file_folder: firefox (Firefox)
|
|
||||||
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
|
|
||||||
- :open_file_folder: dns_over_https (DNS over HTTPS)
|
|
||||||
- :notebook: enable_dns_over_https (Enable DNS over HTTPS): <span style="color: #B8860B">false</span>
|
|
||||||
- :open_file_folder: foxyproxy (FoxyProxy)
|
|
||||||
- :open_file_folder: proxies (Proxy configuration): <span style="color: #B8860B">[]</span>
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
|
|
||||||
- [[tutorial v1.1_201] redefines the behavior to password mandatory if the user is defined](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_201~1..v1.1_201))
|
|
||||||
|
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
---
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
<pre>╭─────── Caption ────────╮
|
|
||||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
||||||
╰────────────────────────╯
|
|
||||||
Variables:
|
|
||||||
<span style="color: #5c5cff">┣━━ </span>📂 firefox (Firefox)
|
|
||||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 proxy_mode (Configure Proxy Access to the Internet): <span style="color: #ffd700">No proxy</span>
|
|
||||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📂 dns_over_https (DNS over HTTPS)
|
|
||||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 enable_dns_over_https (Enable DNS over HTTPS): <span style="color: #ffd700">false</span>
|
|
||||||
<span style="color: #5c5cff">┗━━ </span>📂 foxyproxy (FoxyProxy)
|
|
||||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 proxies (Proxy configuration): <span style="color: #ffd700">[]</span>
|
|
||||||
</pre>
|
|
||||||
31
tree.html
31
tree.html
|
|
@ -1,17 +1,18 @@
|
||||||
<p>
|
<p>
|
||||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./">.</a><br/>
|
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./">.</a><br/>
|
||||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./firefox/">firefox</a><br/>
|
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./firefox/">firefox</a><br/>
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./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_201/./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_200/./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_201/./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_200/./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_201/./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_200/./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_201/./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_200/./foxyproxy/">foxyproxy</a><br/>
|
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./foxyproxy/">foxyproxy</a><br/>
|
||||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./types/">types</a><br/>
|
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./foxyproxy/10-redefine.yml">10-redefine.yml</a><br/>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./types/proxy/">proxy</a><br/>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./types/">types</a><br/>
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/./types/proxy/00_type.yml">00_type.yml</a><br/>
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./types/proxy/">proxy</a><br/>
|
||||||
|
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_201/./types/proxy/00_type.yml">00_type.yml</a><br/>
|
||||||
<br/><br/></p>
|
<br/><br/></p>
|
||||||
Loading…
Reference in a new issue