diff --git a/README.md b/README.md
index 8bc626b7..37cf7966 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
-- [[tutorial v1.1_092] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_092/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_092~1..v1.1_092))
+- [[tutorial v1.1_093] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_093/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_093~1..v1.1_093))
-# [tutorial v1.1_093] Examples
+# [tutorial v1.1_094] Help
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_093~1..v1.1_093)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094)
-[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#examples)
+[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#help)
## 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_093
+git switch --detach v1.1_094
```
## Structure
@@ -39,13 +39,13 @@ git switch --detach v1.1_093
-.
- └── firefox
- ├── 00-proxy.yml
- ├── 10-manual.yml
- ├── 20-manual.yml
- ├── 30-auto.yml
- └── 40-no_proxy.yml
+.
+ └── firefox
+ ├── 00-proxy.yml
+ ├── 10-manual.yml
+ ├── 20-manual.yml
+ ├── 30-auto.yml
+ └── 40-no_proxy.yml
Contents of the firefox/40-no_proxy.yml file
@@ -57,6 +57,7 @@ version: 1.1
no_proxy:
description: Address for which proxy will be desactivated
+ help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied
examples:
- .mozilla.org
- .net.nz
@@ -127,10 +128,10 @@ rougail -m firefox/ -o doc
| **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 "[HTTP Port](#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.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" |
-| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
**Validators**:
• type domainname
• 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 "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
+| Variable | Description |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **auto**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validators**:
• well-known ports (1 to 1023) are allowed
• registred ports (1024 to 49151) are allowed
• type domainname
• the domain name can be a hostname
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL" |
+| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
• type domainname
• 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 "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
### Let's generate the changelog
@@ -139,9 +140,9 @@ rougail -m firefox/ -o doc --doc.contents changelog
```
#### Modified variable
-| Variable | Description |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
**Validators**:
• type domainname
• 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 "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
+| Variable | Description |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
• type domainname
• 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 "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" |
## User datas
@@ -174,9 +175,6 @@ Variables:
---
proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat
-no_proxy:
- - example.net
- - 192.168.1.0/24
```
#### Output
@@ -192,9 +190,7 @@ Variables:
┃ ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀
┃ loaded from the YAML file "config/02/config.yml"
-┗━━ 📓 Address for which proxy will be desactivated:
- ┣━━ example.net ◀ loaded from the YAML file "config/02/config.yml"
- ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/02/config.yml"
+┗━━ 📓 Address for which proxy will be desactivated:
### Example 3
@@ -205,6 +201,9 @@ Variables:
---
proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat
+no_proxy:
+ - .example.net
+ - 192.168.1.0/24
```
#### Output
@@ -220,8 +219,10 @@ Variables:
┃ ◀ loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀
┃ loaded from the YAML file "config/03/config.yml"
-┗━━ 📓 Address for which proxy will be desactivated:
+┗━━ 📓 Address for which proxy will be desactivated:
+ ┣━━ .example.net ◀ loaded from the YAML file "config/03/config.yml"
+ ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/03/config.yml"
-- [[tutorial v1.1_094] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_094/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094))
+- [[tutorial v1.1_095] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_095/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095))
diff --git a/config/02/config.yml b/config/02/config.yml
index ccba4c0f..307e175b 100644
--- a/config/02/config.yml
+++ b/config/02/config.yml
@@ -1,6 +1,3 @@
---
proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat
-no_proxy:
- - example.net
- - 192.168.1.0/24
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index d43ac682..cdfa5a40 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -7,7 +7,5 @@ Variables:
┃ ◀ loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀
┃ loaded from the YAML file "config/02/config.yml"
-┗━━ 📓 Address for which proxy will be desactivated:
- ┣━━ example.net ◀ loaded from the YAML file "config/02/config.yml"
- ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/02/config.yml"
+┗━━ 📓 Address for which proxy will be desactivated:
diff --git a/config/03/config.yml b/config/03/config.yml
index 307e175b..53198970 100644
--- a/config/03/config.yml
+++ b/config/03/config.yml
@@ -1,3 +1,6 @@
---
proxy_mode: Automatic proxy configuration URL
auto: https://auto.proxy.net/wpad.dat
+no_proxy:
+ - .example.net
+ - 192.168.1.0/24
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index 3d773445..9cc4dbf6 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -7,5 +7,7 @@ Variables:
┃ ◀ loaded from the YAML file "config/03/config.yml" (⏳ No proxy)
┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀
┃ loaded from the YAML file "config/03/config.yml"
-┗━━ 📓 Address for which proxy will be desactivated:
+┗━━ 📓 Address for which proxy will be desactivated:
+ ┣━━ .example.net ◀ loaded from the YAML file "config/03/config.yml"
+ ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/03/config.yml"
diff --git a/tree.html b/tree.html
index 77b26aaf..2280a3d0 100644
--- a/tree.html
+++ b/tree.html
@@ -25,13 +25,13 @@
Directory Tree
- .
- └── firefox
- ├── 00-proxy.yml
- ├── 10-manual.yml
- ├── 20-manual.yml
- ├── 30-auto.yml
- └── 40-no_proxy.yml
+ .
+ └── firefox
+ ├── 00-proxy.yml
+ ├── 10-manual.yml
+ ├── 20-manual.yml
+ ├── 30-auto.yml
+ └── 40-no_proxy.yml
2 directories, 5 files