diff --git a/README.md b/README.md index af6dadde..5f547240 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_062] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_062~1..v1.1_062)) +- [[tutorial v1.1_063] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_063/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_063~1..v1.1_063)) -# [tutorial v1.1_063)] Examples +# [tutorial v1.1_064)] Help -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_063~1..v1.1_063) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_064~1..v1.1_064) ## Screenshot @@ -140,6 +140,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 @@ -161,7 +162,7 @@ no_proxy: ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_063 +foo@bar:~$ git switch --detach v1.1_064 foo@bar:~$ rougail -m firefox/ -o doc -do github ``` | Variable                                                                                        | Description                                                                                     | @@ -212,19 +213,19 @@ This family builds families dynamically | 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.
**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" | +| **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" | ### Let's generate the changelog ```console -foo@bar:~$ git switch --detach v1.1_063 +foo@bar:~$ git switch --detach v1.1_064 foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github ``` #### Modified variable | Variable                                                                                                                 | Description                                                                                                              | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
**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" | +| **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" | ## User datas @@ -241,7 +242,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github #### Output ```console -foo@bar:~$ git switch --detach v1.1_063 +foo@bar:~$ git switch --detach v1.1_064 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml ``` 
╭─────── Caption ────────╮
@@ -257,13 +258,14 @@ Variables:
 
 ```yml
 ---
-proxy_mode: No proxy
+proxy_mode: Automatic proxy configuration URL
+auto: https://auto.proxy.net/wpad.dat
 
 ```
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_063
+foo@bar:~$ git switch --detach v1.1_064
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
 ```
 
╭────────────── Caption ───────────────╮
@@ -271,7 +273,9 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)
+┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/02/config.yaml"
+┗━━ 📓 Address for which proxy will be desactivated: 
 

 ### Example 3
 
@@ -280,73 +284,30 @@ Variables:
 
 ```yml
 ---
-proxy_mode: Manual proxy configuration
+proxy_mode: Automatic proxy configuration URL
+auto: https://auto.proxy.net/wpad.dat
+no_proxy:
+  - .example.net
+  - 192.168.1.0/24
 
 ```
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_063
+foo@bar:~$ git switch --detach v1.1_064
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
 ```
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┣━━ HTTP Proxy
-        ┃   ┗━━ HTTP address
-        ┗━━ SOCKS Proxy
-            ┗━━ SOCKS address
-

-### Example 4
-
-#### config/04/config.yaml
-
-
-```yml
----
-proxy_mode: foo
-
-```
-#### Output
-
-```console
-foo@bar:~$ git switch --detach v1.1_063
-foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
-```
-
🔔 WARNINGS
-┗━━ the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
-    configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/04/config.yaml"
-╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
+
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
 Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-

-### Example 5
-
-#### config/05/config.yaml
-
-
-```yml
----
-proxy_mode: 1
-
-```
-#### Output
-
-```console
-foo@bar:~$ git switch --detach v1.1_063
-foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
-```
-
🔔 WARNINGS
-┗━━ the value "1" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
-    configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/05/config.yaml"
-╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
+┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yaml"
+┗━━ 📓 Address for which proxy will be desactivated:
+    ┣━━ .example.net ◀ loaded from the YAML file "config/03/config.yaml"
+    ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/03/config.yaml"
 

 
 
-- [[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))
diff --git a/config/02/config.yaml b/config/02/config.yaml
index d9144882..307e175b 100644
--- a/config/02/config.yaml
+++ b/config/02/config.yaml
@@ -1,2 +1,3 @@
 ---
-proxy_mode: No proxy
+proxy_mode: Automatic proxy configuration URL
+auto: https://auto.proxy.net/wpad.dat
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index b0153620..040a86c6 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -3,5 +3,7 @@
 │          (⏳ Original default value) │
 ╰──────────────────────────────────────╯
 Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/02/config.yaml" (⏳ No proxy)
+┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/02/config.yaml"
+┗━━ 📓 Address for which proxy will be desactivated: 
 

diff --git a/config/03/config.yaml b/config/03/config.yaml
index 74edb225..53198970 100644
--- a/config/03/config.yaml
+++ b/config/03/config.yaml
@@ -1,2 +1,6 @@
 ---
-proxy_mode: Manual proxy configuration
+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 a4d85106..01c275a7 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -1,8 +1,11 @@
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Manual proxy configuration
-        ┣━━ HTTP Proxy
-        ┃   ┗━━ HTTP address
-        ┗━━ SOCKS Proxy
-            ┗━━ SOCKS address
+
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/03/config.yaml" (⏳ No proxy)
+┣━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yaml"
+┗━━ 📓 Address for which proxy will be desactivated:
+    ┣━━ .example.net ◀ loaded from the YAML file "config/03/config.yaml"
+    ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/03/config.yaml"
 

diff --git a/config/04/config.yaml b/config/04/config.yaml
deleted file mode 100644
index e3fa25da..00000000
--- a/config/04/config.yaml
+++ /dev/null
@@ -1,2 +0,0 @@
----
-proxy_mode: foo
diff --git a/config/04/output_ro.html b/config/04/output_ro.html
deleted file mode 100644
index 3b735cce..00000000
--- a/config/04/output_ro.html
+++ /dev/null
@@ -1,9 +0,0 @@
-
🔔 WARNINGS
-┗━━ the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
-    configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/04/config.yaml"
-╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-

diff --git a/config/05/config.yaml b/config/05/config.yaml
deleted file mode 100644
index bf6f64ca..00000000
--- a/config/05/config.yaml
+++ /dev/null
@@ -1,2 +0,0 @@
----
-proxy_mode: 1
diff --git a/config/05/output_ro.html b/config/05/output_ro.html
deleted file mode 100644
index 21c747f4..00000000
--- a/config/05/output_ro.html
+++ /dev/null
@@ -1,9 +0,0 @@
-
🔔 WARNINGS
-┗━━ the value "1" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy 
-    configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/05/config.yaml"
-╭─────── Caption ────────╮
-│ Variable Default value │
-╰────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-