[tutorial v1.1_066)] A variable (config and doc)
This commit is contained in:
parent
c441bddec4
commit
670f6b1161
5 changed files with 44 additions and 27 deletions
55
README.md
55
README.md
|
|
@ -1,9 +1,9 @@
|
|||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||
- [[tutorial v1.1_064] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_064/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_064~1..v1.1_064))
|
||||
- [[tutorial v1.1_065] A variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_065/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_065~1..v1.1_065))
|
||||
|
||||
# [tutorial v1.1_065)] A variable
|
||||
# [tutorial v1.1_066)] A variable
|
||||
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_065~1..v1.1_065)
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_066~1..v1.1_066)
|
||||
|
||||
|
||||
## Screenshot
|
||||
|
|
@ -175,11 +175,23 @@ prompt_authentication:
|
|||
when: No proxy
|
||||
...
|
||||
|
||||
```
|
||||
### firefox/55-proxy_dns_socks5.yml
|
||||
|
||||
|
||||
```yml
|
||||
%YAML 1.2
|
||||
---
|
||||
version: 1.1
|
||||
|
||||
proxy_dns_socks5: false # Use proxy DNS when using SOCKS v5
|
||||
...
|
||||
|
||||
```
|
||||
### Let's generate the documentation
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_065
|
||||
foo@bar:~$ git switch --detach v1.1_066
|
||||
foo@bar:~$ rougail -m firefox/ -o doc -do github
|
||||
```
|
||||
| Variable | Description |
|
||||
|
|
@ -232,18 +244,19 @@ This family builds families dynamically
|
|||
| **auto**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.<br/>**Validator**: the domain name in web address can be only a hostname<br/>**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL" |
|
||||
| **no_proxy**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.<br/>Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.<br/>**Validators**: <br/>- the domain name can starts by a dot<br/>- the domain name can be a hostname<br/>- the domain name can be an IP<br/>- the domain name can be network in CIDR format<br/>**Examples**: <br/>- .mozilla.org<br/>- .net.nz<br/>- 192.168.1.0/24<br/>**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
|
||||
| **prompt_authentication**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
|
||||
| **proxy_dns_socks5**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.<br/>**Default**: false |
|
||||
|
||||
### Let's generate the changelog
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_065
|
||||
foo@bar:~$ git switch --detach v1.1_066
|
||||
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
|
||||
```
|
||||
#### New variable
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **prompt_authentication**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **proxy_dns_socks5**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.<br/>**Default**: false |
|
||||
|
||||
|
||||
## User datas
|
||||
|
|
@ -260,14 +273,15 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
|
|||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_065
|
||||
foo@bar:~$ git switch --detach v1.1_066
|
||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
|
||||
```
|
||||
<pre>╭─────── Caption ────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
╰────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
### Example 2
|
||||
|
||||
|
|
@ -285,7 +299,7 @@ manual:
|
|||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_065
|
||||
foo@bar:~$ git switch --detach v1.1_066
|
||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
|
||||
```
|
||||
<pre>╭────────────── Caption ───────────────╮
|
||||
|
|
@ -305,7 +319,8 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
### Example 3
|
||||
|
||||
|
|
@ -324,12 +339,10 @@ proxy_dns_socks5: true
|
|||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_065
|
||||
foo@bar:~$ git switch --detach v1.1_066
|
||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
|
||||
```
|
||||
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||||
<span style="color: #ffff00">┗━━ </span>variable or family "proxy_dns_socks5" does not exist, it will be ignored when loading from the YAML file "config/03/config.yaml"
|
||||
╭────────────── Caption ───────────────╮
|
||||
<pre>╭────────────── Caption ───────────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
│ Modified value │
|
||||
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
||||
|
|
@ -346,7 +359,8 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: true ◀ loaded from the YAML file "config/03/config.yaml" (⏳ <span style="color: #00aa00">false</span>)
|
||||
</pre>
|
||||
### Example 4
|
||||
|
||||
|
|
@ -366,7 +380,7 @@ manual:
|
|||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_065
|
||||
foo@bar:~$ git switch --detach v1.1_066
|
||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
|
||||
```
|
||||
<pre>╭────────────── Caption ───────────────╮
|
||||
|
|
@ -386,8 +400,9 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ <span style="color: #00aa00">v5</span>)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
|
||||
|
||||
- [[tutorial v1.1_066] A variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_066/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_066~1..v1.1_066))
|
||||
- [[tutorial v1.1_067] Jinja calculation for an hidden variable with a potential inaccessible varible](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_067/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_067~1..v1.1_067))
|
||||
|
|
|
|||
|
|
@ -2,5 +2,6 @@
|
|||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
╰────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -15,5 +15,6 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,4 @@
|
|||
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
||||
<span style="color: #ffff00">┗━━ </span>variable or family "proxy_dns_socks5" does not exist, it will be ignored when loading from the YAML file "config/03/config.yaml"
|
||||
╭────────────── Caption ───────────────╮
|
||||
<pre>╭────────────── Caption ───────────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
│ Modified value │
|
||||
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
||||
|
|
@ -17,5 +15,6 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: <span style="color: #ffd700">v5</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: true ◀ loaded from the YAML file "config/03/config.yaml" (⏳ <span style="color: #00aa00">false</span>)
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -15,5 +15,6 @@ Variables:
|
|||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 SOCKS port: <span style="color: #ffd700">8080</span>
|
||||
<span style="color: #5c5cff">┃ </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ <span style="color: #00aa00">v5</span>)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Address for which proxy will be desactivated:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 Prompt for authentication if password is saved: <span style="color: #ffd700">true</span>
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 Use proxy DNS when using SOCKS v5: <span style="color: #ffd700">false</span>
|
||||
</pre>
|
||||
|
|
|
|||
Loading…
Reference in a new issue