[tutorial v1.1_100] A boolean variable (config and doc)
This commit is contained in:
parent
70b6b92bb8
commit
d8410e6189
13 changed files with 56 additions and 267 deletions
207
README.md
207
README.md
|
|
@ -1,11 +1,11 @@
|
|||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||
- [[tutorial v1.1_097] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_097/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_097~1..v1.1_097))
|
||||
- [[tutorial v1.1_098] A variable in avanced mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_098~1..v1.1_098))
|
||||
|
||||
# [tutorial v1.1_098] A variable in avanced mode
|
||||
# [tutorial v1.1_100] A boolean variable
|
||||
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_098~1..v1.1_098)
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100)
|
||||
|
||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-in-avanced-mode)
|
||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable)
|
||||
|
||||
|
||||
## Screenshot
|
||||
|
|
@ -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_098
|
||||
git switch --detach v1.1_100
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
|
@ -39,38 +39,28 @@ git switch --detach v1.1_098
|
|||
|
||||
|
||||
<p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./">.</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./firefox/">firefox</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./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_098/./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_098/./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_100/./">.</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/">firefox</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./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_100/./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_100/./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_100/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br/>
|
||||
<br/><br/></p>
|
||||
|
||||
Contents of the firefox/55-proxy_dns_socks5.yml file
|
||||
Contents of the firefox/60-dns_over_https.yml file
|
||||
|
||||
```yml
|
||||
%YAML 1.2
|
||||
---
|
||||
version: 1.1
|
||||
|
||||
proxy_dns_socks5:
|
||||
description: Use proxy DNS when using SOCKS v5
|
||||
mode: advanced
|
||||
default: false
|
||||
disabled:
|
||||
jinja: |-
|
||||
{% if _.manual.socks_proxy.version is propertyerror %}
|
||||
the proxy mode is not manual
|
||||
{% elif _.manual.socks_proxy.version == 'v4' %}
|
||||
socks version is v4
|
||||
{% endif %}
|
||||
description: |-
|
||||
if "firefox.proxy_mode" is not "Manual proxy configuration"
|
||||
or "firefox.manual.socks_proxy.version" is "v4"
|
||||
dns_over_https: # DNS over HTTPS
|
||||
|
||||
enable_dns_over_https: false # Enable DNS over HTTPS
|
||||
...
|
||||
|
||||
```
|
||||
|
|
@ -134,26 +124,27 @@ rougail -m firefox/ --modes_level basic standard advanced -o doc
|
|||
| **<a id="prompt_authentication" name="prompt_authentication">prompt_authentication</a>**<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 "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
|
||||
| **<a id="proxy_dns_socks5" name="proxy_dns_socks5">proxy_dns_socks5</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.<br/>**Default**: false<br/>**Disabled**: if "firefox.proxy_mode" is not "Manual proxy configuration"<br/>or "firefox.manual.socks_proxy.version" is "v4" |
|
||||
|
||||
#### DNS over HTTPS
|
||||
|
||||
> **🛈 Informations**
|
||||
>
|
||||
> **Path**: dns_over_https\
|
||||
> `standard`
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
|
||||
| **<a id="dns_over_https.enable_dns_over_https" name="dns_over_https.enable_dns_over_https">dns_over_https.enable_dns_over_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.<br/>**Default**: false |
|
||||
|
||||
### Let's generate the changelog
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ --modes_level basic standard advanced -o doc --doc.contents changelog
|
||||
```
|
||||
#### Modified variables
|
||||
#### New variable
|
||||
|
||||
| Variable | Description |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="proxy_mode" name="proxy_mode">proxy_mode</a>**<br/>~~`(None, [], ['standard'])`~~ [`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 |
|
||||
| **<a id="manual.http_proxy.address" name="manual.http_proxy.address">manual.http_proxy.address</a>**<br/>~~`(None, [], ['basic'])`~~ [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP address.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP |
|
||||
| **<a id="manual.http_proxy.port" name="manual.http_proxy.port">manual.http_proxy.port</a>**<br/>~~`(None, [], ['standard'])`~~ [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTP 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**: 8080 |
|
||||
| **<a id="manual.use_for_https" name="manual.use_for_https">manual.use_for_https</a>**<br/>~~`(None, [], ['standard'])`~~ [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
|
||||
| **<a id="manual.:::identifier:::_proxy.address" name="manual.:::identifier:::_proxy.address">manual.*https*_proxy.address</a>**<br/>**manual.*socks*_proxy.address**<br/>~~`(None, [], ['standard'])`~~ [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | *HTTPS* or *SOCKS* address.<br/>**Validators**: <br/>• type domainname<br/>• the domain name can be an IP<br/>**Default**: the value of the variable "[HTTP address](#manual.http_proxy.address)" |
|
||||
| **<a id="manual.:::identifier:::_proxy.port" name="manual.:::identifier:::_proxy.port">manual.*https*_proxy.port</a>**<br/>**manual.*socks*_proxy.port**<br/>~~`(None, [], ['standard'])`~~ [`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | *HTTPS* or *SOCKS* 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**: the value of the variable "[HTTP Port](#manual.http_proxy.port)" |
|
||||
| **<a id="manual.:::identifier:::_proxy.version" name="manual.:::identifier:::_proxy.version">manual.*https*_proxy.version</a>**<br/>**manual.*socks*_proxy.version**<br/>~~`(None, [], ['standard'])`~~ [`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" |
|
||||
| **<a id="auto" name="auto">auto</a>**<br/>~~`(None, [], ['basic'])`~~ [`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Automatic proxy configuration 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/>**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" |
|
||||
| **<a id="no_proxy" name="no_proxy">no_proxy</a>**<br/>~~`(None, [], ['standard'])`~~ [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` *`disabled`* `unique` | Address for which proxy will be desactivated.<br/>Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.<br/>**Validators**: <br/>• type domainname<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 "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
|
||||
| **<a id="prompt_authentication" name="prompt_authentication">prompt_authentication</a>**<br/>~~`(None, [], ['standard'])`~~ [`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 "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
|
||||
| **<a id="proxy_dns_socks5" name="proxy_dns_socks5">proxy_dns_socks5</a>**<br/>~~`(None, [], ['advanced'])`~~ [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.<br/>**Default**: false<br/>**Disabled**: if "firefox.proxy_mode" is not "Manual proxy configuration"<br/>or "firefox.manual.socks_proxy.version" is "v4" |
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
|
||||
| **<a id="dns_over_https.enable_dns_over_https" name="dns_over_https.enable_dns_over_https">dns_over_https.enable_dns_over_https</a>**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.<br/>**Default**: false |
|
||||
|
||||
|
||||
## User datas
|
||||
|
|
@ -172,132 +163,14 @@ rougail -m firefox/ --modes_level basic standard advanced -o doc --doc.contents
|
|||
rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/01/config.yml
|
||||
```
|
||||
<pre>╭──────────────────── Caption ─────────────────────╮
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span> │
|
||||
│ <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: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</span>
|
||||
</pre>
|
||||
### Example 2
|
||||
|
||||
#### config/02/config.yml
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
manual:
|
||||
http_proxy:
|
||||
address: http.proxy.net
|
||||
```
|
||||
#### Output
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/02/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> <span style="color: #00aa00">Modified value</span> │
|
||||
│ (⏳ Original default value) │
|
||||
╰────────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀
|
||||
<span style="color: #5c5cff">┃ </span>loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
|
||||
<span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">Manual proxy configuration</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">HTTP Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">HTTP address</span>: <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML file
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span>"config/02/config.yml"
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">HTTP Port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Also use this proxy for HTTPS</span>: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">SOCKS Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS 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: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
### Example 3
|
||||
|
||||
#### config/03/config.yml
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
manual:
|
||||
http_proxy:
|
||||
address: http.proxy.net
|
||||
proxy_dns_socks5: true
|
||||
```
|
||||
#### Output
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/03/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> <span style="color: #00aa00">Modified value</span> │
|
||||
│ (⏳ Original default value) │
|
||||
╰────────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀
|
||||
<span style="color: #5c5cff">┃ </span>loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
|
||||
<span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">Manual proxy configuration</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">HTTP Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">HTTP address</span>: <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML file
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span>"config/03/config.yml"
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">HTTP Port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Also use this proxy for HTTPS</span>: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">SOCKS Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS 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: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #00aa00">true</span> ◀ loaded from the YAML file
|
||||
<span style="color: #5c5cff"> </span>"config/03/config.yml" (⏳ false)
|
||||
</pre>
|
||||
### Example 4
|
||||
|
||||
#### config/04/config.yml
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
manual:
|
||||
http_proxy:
|
||||
address: http.proxy.net
|
||||
socks_proxy:
|
||||
version: v4
|
||||
```
|
||||
#### Output
|
||||
|
||||
```shell
|
||||
rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/04/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> <span style="color: #00aa00">Modified value</span> │
|
||||
│ (⏳ Original default value) │
|
||||
╰────────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀
|
||||
<span style="color: #5c5cff">┃ </span>loaded from the YAML file "config/04/config.yml" (⏳ No proxy)
|
||||
<span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">Manual proxy configuration</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">HTTP Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">HTTP address</span>: <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML file
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span>"config/04/config.yml"
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">HTTP Port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Also use this proxy for HTTPS</span>: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">SOCKS Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS 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: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #00aa00">v4</span> ◀ loaded from the YAML file
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span>"config/04/config.yml" (⏳ v5)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</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">DNS over HTTPS</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>
|
||||
</pre>
|
||||
|
||||
|
||||
- [[tutorial v1.1_100] A boolean variable](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))
|
||||
- [[tutorial v1.1_101] A choice variable](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,6 +1,9 @@
|
|||
<pre>╭──────────────────── Caption ─────────────────────╮
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span> │
|
||||
│ <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: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">No proxy</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">DNS over HTTPS</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>
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/02/config.yml
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
manual:
|
||||
http_proxy:
|
||||
address: http.proxy.net
|
||||
|
|
@ -1,22 +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> <span style="color: #00aa00">Modified value</span> │
|
||||
│ (⏳ Original default value) │
|
||||
╰────────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀
|
||||
<span style="color: #5c5cff">┃ </span>loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
|
||||
<span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">Manual proxy configuration</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">HTTP Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">HTTP address</span>: <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML file
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span>"config/02/config.yml"
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">HTTP Port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Also use this proxy for HTTPS</span>: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">SOCKS Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS 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: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
|
|
@ -1 +0,0 @@
|
|||
rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/03/config.yml
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
manual:
|
||||
http_proxy:
|
||||
address: http.proxy.net
|
||||
proxy_dns_socks5: true
|
||||
|
|
@ -1,23 +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> <span style="color: #00aa00">Modified value</span> │
|
||||
│ (⏳ Original default value) │
|
||||
╰────────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀
|
||||
<span style="color: #5c5cff">┃ </span>loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
|
||||
<span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">Manual proxy configuration</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">HTTP Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">HTTP address</span>: <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML file
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span>"config/03/config.yml"
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">HTTP Port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Also use this proxy for HTTPS</span>: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">SOCKS Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS 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: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Use proxy DNS when using SOCKS v5</span>: <span style="color: #00aa00">true</span> ◀ loaded from the YAML file
|
||||
<span style="color: #5c5cff"> </span>"config/03/config.yml" (⏳ false)
|
||||
</pre>
|
||||
|
|
@ -1 +0,0 @@
|
|||
rougail -m firefox/ --modes_level basic standard advanced -u yaml -yf config/04/config.yml
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
manual:
|
||||
http_proxy:
|
||||
address: http.proxy.net
|
||||
socks_proxy:
|
||||
version: v4
|
||||
|
|
@ -1,22 +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> <span style="color: #00aa00">Modified value</span> │
|
||||
│ (⏳ Original default value) │
|
||||
╰────────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #00aa00">Manual proxy configuration</span> ◀
|
||||
<span style="color: #5c5cff">┃ </span>loaded from the YAML file "config/04/config.yml" (⏳ No proxy)
|
||||
<span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">Manual proxy configuration</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📂 <span style="color: #5c5cff">HTTP Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">HTTP address</span>: <span style="color: #00aa00">http.proxy.net</span> ◀ loaded from the YAML file
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span>"config/04/config.yml"
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">HTTP Port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Also use this proxy for HTTPS</span>: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📂 <span style="color: #5c5cff">SOCKS Proxy</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">SOCKS 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: #ff0000">SOCKS port</span>: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">SOCKS host version used by proxy</span>: <span style="color: #00aa00">v4</span> ◀ loaded from the YAML file
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span>"config/04/config.yml" (⏳ v5)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 <span style="color: #ff0000">Address for which proxy will be desactivated</span>:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Prompt for authentication if password is saved</span>: <span style="color: #ffd700">true</span>
|
||||
</pre>
|
||||
BIN
firefox.png
BIN
firefox.png
Binary file not shown.
|
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 118 KiB |
21
tree.html
21
tree.html
|
|
@ -25,18 +25,19 @@
|
|||
</head>
|
||||
<body>
|
||||
<h1>Directory Tree</h1><p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./">.</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./firefox/">firefox</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./firefox/10-manual.yml">10-manual.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./firefox/20-manual.yml">20-manual.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./firefox/30-auto.yml">30-auto.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_098/./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_098/./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_098/./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_100/./">.</a><br>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/">firefox</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/10-manual.yml">10-manual.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/20-manual.yml">20-manual.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./firefox/30-auto.yml">30-auto.yml</a><br>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/./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_100/./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_100/./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_100/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br>
|
||||
<br><br><p>
|
||||
|
||||
2 directories, 7 files
|
||||
2 directories, 8 files
|
||||
|
||||
</p>
|
||||
<hr>
|
||||
|
|
|
|||
Loading…
Reference in a new issue