diff --git a/README.md b/README.md index d74de143..f7fdfd5c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [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 @@ -184,14 +184,26 @@ prompt_authentication: --- 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 ```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 ``` | Variable                                                                                        | Description                                                                                     | @@ -239,24 +251,26 @@ This family builds families dynamically | **manual.*https*_proxy.port**
**manual.*socks*_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* port.
**Validators**:
- well-known ports (1 to 1023) are allowed
- registred ports (1024 to 49151) are allowed
- private ports (greater than 49152) are allowed
**Default**: the value of the variable "manual.http_proxy.port" | | **manual.*https*_proxy.version**
**manual.*socks*_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS host version used by proxy.
**Choices**:
- v4
- v5 **← (default)**
**Disabled**: when the identifier is "HTTPS" | -| Variable                                                                                                                 | Description                                                                                                              | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL" | -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
- the domain name can starts by a dot
- the domain name can be a hostname
- the domain name can be an IP
- the domain name can be network in CIDR format
**Examples**:
- .mozilla.org
- .net.nz
- 192.168.1.0/24
**Disabled**: when the variable "proxy_mode" has the value "No proxy" | -| **prompt_authentication**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.
**Default**: true
**Disabled**: when the variable "proxy_mode" has the value "No proxy" | -| **proxy_dns_socks5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.
**Default**: false | +| Variable                                                                                                                   | Description                                                                                                                | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL" | +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
- the domain name can starts by a dot
- the domain name can be a hostname
- the domain name can be an IP
- the domain name can be network in CIDR format
**Examples**:
- .mozilla.org
- .net.nz
- 192.168.1.0/24
**Disabled**: when the variable "proxy_mode" has the value "No proxy" | +| **prompt_authentication**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.
**Default**: true
**Disabled**: when the variable "proxy_mode" has the value "No proxy" | +| **proxy_dns_socks5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.
**Default**: false
**Disabled**: if "firefox.proxy_mode" is not "Manual proxy configuration" +or "firefox.manual.socks_proxy.version" is "v4" | ### Let's generate the changelog ```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 ``` -#### New variable +#### Modified variable -| Variable                                                                                         | Description                                                                                      | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **proxy_dns_socks5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Use proxy DNS when using SOCKS v5.
**Default**: false | +| Variable                                                                                                                              | Description                                                                                                                           | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **proxy_dns_socks5**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.
**Default**: false
**Disabled**: if "firefox.proxy_mode" is not "Manual proxy configuration" +or "firefox.manual.socks_proxy.version" is "v4" | ## User datas @@ -273,15 +287,14 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github #### Output ```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 ```
╭─────── Caption ────────╮
 │ Variable Default value │
 ╰────────────────────────╯
 Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📓 Use proxy DNS when using SOCKS v5: false
+┗━━ 📓 Configure Proxy Access to the Internet: No proxy
 
### Example 2 @@ -299,7 +312,7 @@ manual: #### Output ```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 ```
╭────────────── Caption ───────────────╮
@@ -339,7 +352,7 @@ proxy_dns_socks5: true
 #### Output
 
 ```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
 ```
 
╭────────────── Caption ───────────────╮
@@ -380,7 +393,7 @@ manual:
 #### Output
 
 ```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
 ```
 
╭────────────── Caption ───────────────╮
@@ -400,9 +413,8 @@ Variables:
     ┣━━ 📓 SOCKS port: 8080
     ┗━━ 📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ v5)
 ┣━━ 📓 Address for which proxy will be desactivated: 
-┣━━ 📓 Prompt for authentication if password is saved: true
-┗━━ 📓 Use proxy DNS when using SOCKS v5: false
+┗━━ 📓 Prompt for authentication if password is saved: true
 
-- [[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)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 450d0a74..ea9c2266 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -2,6 +2,5 @@ │ Variable Default value │ ╰────────────────────────╯ Variables: -┣━━ 📓 Configure Proxy Access to the Internet: No proxy -┗━━ 📓 Use proxy DNS when using SOCKS v5: false +┗━━ 📓 Configure Proxy Access to the Internet: No proxy
diff --git a/config/04/output_ro.html b/config/04/output_ro.html index 242db320..cb68c0ff 100644 --- a/config/04/output_ro.html +++ b/config/04/output_ro.html @@ -15,6 +15,5 @@ Variables: ┣━━ 📓 SOCKS port: 8080 ┗━━ 📓 SOCKS host version used by proxy: v4 ◀ loaded from the YAML file "config/04/config.yaml" (⏳ v5) ┣━━ 📓 Address for which proxy will be desactivated: -┣━━ 📓 Prompt for authentication if password is saved: true -┗━━ 📓 Use proxy DNS when using SOCKS v5: false +┗━━ 📓 Prompt for authentication if password is saved: true