[tutorial v1.1_067)] Jinja calculation for an hidden variable with a potential inaccessible varible (config and doc)
This commit is contained in:
parent
81d9cb11e1
commit
5d79934601
3 changed files with 39 additions and 29 deletions
62
README.md
62
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_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_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_066)] A variable
|
# [tutorial v1.1_067)] Jinja calculation for an hidden variable with a potential inaccessible varible
|
||||||
|
|
||||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_066~1..v1.1_066)
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_067~1..v1.1_067)
|
||||||
|
|
||||||
|
|
||||||
## Screenshot
|
## Screenshot
|
||||||
|
|
@ -184,14 +184,26 @@ prompt_authentication:
|
||||||
---
|
---
|
||||||
version: 1.1
|
version: 1.1
|
||||||
|
|
||||||
proxy_dns_socks5: false # Use proxy DNS when using SOCKS v5
|
proxy_dns_socks5:
|
||||||
|
description: Use proxy DNS when using SOCKS v5
|
||||||
|
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"
|
||||||
...
|
...
|
||||||
|
|
||||||
```
|
```
|
||||||
### Let's generate the documentation
|
### Let's generate the documentation
|
||||||
|
|
||||||
```console
|
```console
|
||||||
foo@bar:~$ git switch --detach v1.1_066
|
foo@bar:~$ git switch --detach v1.1_067
|
||||||
foo@bar:~$ rougail -m firefox/ -o doc -do github
|
foo@bar:~$ rougail -m firefox/ -o doc -do github
|
||||||
```
|
```
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|
|
@ -239,24 +251,26 @@ This family builds families dynamically
|
||||||
| **manual.*https*_proxy.port**<br/>**manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `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 "manual.http_proxy.port" |
|
| **manual.*https*_proxy.port**<br/>**manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `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 "manual.http_proxy.port" |
|
||||||
| **manual.*https*_proxy.version**<br/>**manual.*socks*_proxy.version**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.<br/>**Choices**: <br/>- v4<br/>- v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS" |
|
| **manual.*https*_proxy.version**<br/>**manual.*socks*_proxy.version**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.<br/>**Choices**: <br/>- v4<br/>- v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS" |
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| **auto**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `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" |
|
| **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" |
|
| **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" |
|
| **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 |
|
| **proxy_dns_socks5**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.<br/>**Default**: false<br/>**Disabled**: if "firefox.proxy_mode" is not "Manual proxy configuration"
|
||||||
|
or "firefox.manual.socks_proxy.version" is "v4" |
|
||||||
|
|
||||||
### Let's generate the changelog
|
### Let's generate the changelog
|
||||||
|
|
||||||
```console
|
```console
|
||||||
foo@bar:~$ git switch --detach v1.1_066
|
foo@bar:~$ git switch --detach v1.1_067
|
||||||
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
|
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
|
||||||
```
|
```
|
||||||
#### New variable
|
#### Modified variable
|
||||||
|
|
||||||
| Variable | Description |
|
| 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 |
|
| **proxy_dns_socks5**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` <ins>*`disabled`*</ins> | Use proxy DNS when using SOCKS v5.<br/>**Default**: false<br/>**Disabled**: <ins>if "firefox.proxy_mode" is not "Manual proxy configuration"
|
||||||
|
or "firefox.manual.socks_proxy.version" is "v4"</ins> |
|
||||||
|
|
||||||
|
|
||||||
## User datas
|
## User datas
|
||||||
|
|
@ -273,15 +287,14 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
```console
|
```console
|
||||||
foo@bar:~$ git switch --detach v1.1_066
|
foo@bar:~$ git switch --detach v1.1_067
|
||||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
|
||||||
```
|
```
|
||||||
<pre>╭─────── Caption ────────╮
|
<pre>╭─────── Caption ────────╮
|
||||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||||
╰────────────────────────╯
|
╰────────────────────────╯
|
||||||
Variables:
|
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>
|
</pre>
|
||||||
### Example 2
|
### Example 2
|
||||||
|
|
||||||
|
|
@ -299,7 +312,7 @@ manual:
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
```console
|
```console
|
||||||
foo@bar:~$ git switch --detach v1.1_066
|
foo@bar:~$ git switch --detach v1.1_067
|
||||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
|
||||||
```
|
```
|
||||||
<pre>╭────────────── Caption ───────────────╮
|
<pre>╭────────────── Caption ───────────────╮
|
||||||
|
|
@ -339,7 +352,7 @@ proxy_dns_socks5: true
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
```console
|
```console
|
||||||
foo@bar:~$ git switch --detach v1.1_066
|
foo@bar:~$ git switch --detach v1.1_067
|
||||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
|
||||||
```
|
```
|
||||||
<pre>╭────────────── Caption ───────────────╮
|
<pre>╭────────────── Caption ───────────────╮
|
||||||
|
|
@ -380,7 +393,7 @@ manual:
|
||||||
#### Output
|
#### Output
|
||||||
|
|
||||||
```console
|
```console
|
||||||
foo@bar:~$ git switch --detach v1.1_066
|
foo@bar:~$ git switch --detach v1.1_067
|
||||||
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
|
||||||
```
|
```
|
||||||
<pre>╭────────────── Caption ───────────────╮
|
<pre>╭────────────── Caption ───────────────╮
|
||||||
|
|
@ -400,9 +413,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 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><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>📓 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>
|
</pre>
|
||||||
|
|
||||||
|
|
||||||
- [[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))
|
- [[tutorial v1.1_068] A variable in avanced mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_068/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_068~1..v1.1_068))
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,5 @@
|
||||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||||
╰────────────────────────╯
|
╰────────────────────────╯
|
||||||
Variables:
|
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>
|
</pre>
|
||||||
|
|
|
||||||
|
|
@ -15,6 +15,5 @@ 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 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><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>📓 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>
|
</pre>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue