diff --git a/README.md b/README.md index 9a5d3cc4..9fb45b28 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] Jinja with a description](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_065] A variable with type "web_address"](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 with type "web_address" +# [tutorial v1.1_070)] A variable with type "domainname", parameters type and disabled -[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_070~1..v1.1_070) ## Screenshot @@ -29,7 +29,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_065 +git switch --detach v1.1_070 ``` ## Structure @@ -37,24 +37,33 @@ git switch --detach v1.1_065

-.
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     ├── 20-manual.yml
-     └── 30-auto.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     ├── 10-manual.yml
+     ├── 20-manual.yml
+     ├── 30-auto.yml
+     └── 40-no_proxy.yml


-Contents of the firefox/30-auto.yml file +Contents of the firefox/40-no_proxy.yml file ```yml %YAML 1.2 --- version: 1.1 -auto: - description: Automatic proxy configuration URL - type: web_address +no_proxy: + description: Address for which proxy will be desactivated + type: domainname + params: + allow_ip: true + allow_cidr_network: true + allow_without_dot: true + allow_startswith_dot: true + disabled: + variable: _.proxy_mode + when: No proxy ... ``` @@ -108,20 +117,21 @@ 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` | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname | +| Variable                                                                                                         | Description                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname | +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | 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
**Disabled**: when the variable "proxy_mode" has the value "No proxy" | ### Let's generate the changelog ```shell rougail -m firefox/ -o doc --doc.contents changelog ``` -#### Modified variable +#### New variable -| Variable                                                                                                                                                                                                 | Description                                                                                                                                                                                              | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **auto**
~~`disabled`~~ [`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: ~~{'message': 'when the variable "{0}" hasn\'t the value "Automatic proxy configuration URL"', 'path': {'path': 'proxy_mode'}, 'description': 'Configure Proxy Access to the Internet'}~~ | +| Variable                                                                                                         | Description                                                                                                      | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | 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
**Disabled**: when the variable "proxy_mode" has the value "No proxy" | ## User datas @@ -133,20 +143,15 @@ rougail -m firefox/ -o doc --doc.contents changelog ```yml --- -auto: https://auto.proxy.net/wpad.dat ``` #### Output ```shell rougail -m firefox/ -u yaml -yf config/01/config.yml ``` -
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          Modified value │
-╰─────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/01/config.yml"
+
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Automatic proxy configuration URL
 

 ### Example 2
 
@@ -156,39 +161,23 @@ Variables:
 ```yml
 ---
 proxy_mode: Automatic proxy configuration URL
+auto: https://auto.proxy.net/wpad.dat
+no_proxy: 192.168.1.0/24
 ```
 #### Output
 
 ```shell
 rougail -m firefox/ -u yaml -yf config/02/config.yml
 ```
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Automatic proxy configuration URL
-

-### Example 3
-
-#### config/03/config.yml
-
-
-```yml
----
-proxy_mode: Automatic proxy configuration URL
-auto: https://auto.proxy.net/wpad.dat
-```
-#### Output
-
-```shell
-rougail -m firefox/ -u yaml -yf config/03/config.yml
-```
 
╭────────────── 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.yml" (⏳ No proxy)
-┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yml"
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ 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: 192.168.1.0/24 ◀ loaded from the YAML file "config/02/config.yml"
 

 
 
-- [[tutorial v1.1_070] A variable with type "domainname", parameters type and disabled](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_070/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_070~1..v1.1_070))
+- [[tutorial v1.1_071] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_071/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_071~1..v1.1_071))
diff --git a/config/01/config.yml b/config/01/config.yml
index 1edbe913..ed97d539 100644
--- a/config/01/config.yml
+++ b/config/01/config.yml
@@ -1,2 +1 @@
 ---
-auto: https://auto.proxy.net/wpad.dat
diff --git a/config/01/output_ro.html b/config/01/output_ro.html
index 9bf6616e..e1ebfb1d 100644
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@@ -1,8 +1,4 @@
-
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          Modified value │
-╰─────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: No proxy
-┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/01/config.yml"
+
🛑 ERRORS
+┗━━ The following variables are mandatory but have no value:
+    ┗━━ Automatic proxy configuration URL
 

diff --git a/config/02/config.yml b/config/02/config.yml
index 26df1306..54956ea6 100644
--- a/config/02/config.yml
+++ b/config/02/config.yml
@@ -1,2 +1,4 @@
 ---
 proxy_mode: Automatic proxy configuration URL
+auto: https://auto.proxy.net/wpad.dat
+no_proxy: 192.168.1.0/24
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index e1ebfb1d..18660aab 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,4 +1,9 @@
-
🛑 ERRORS
-┗━━ The following variables are mandatory but have no value:
-    ┗━━ Automatic proxy configuration URL
+
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ 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: 192.168.1.0/24 ◀ loaded from the YAML file "config/02/config.yml"
 

diff --git a/config/03/cmd_ro.txt b/config/03/cmd_ro.txt
deleted file mode 100644
index fc8085eb..00000000
--- a/config/03/cmd_ro.txt
+++ /dev/null
@@ -1 +0,0 @@
-rougail -m firefox/ -u yaml -yf config/03/config.yml
\ No newline at end of file
diff --git a/config/03/config.yml b/config/03/config.yml
deleted file mode 100644
index 307e175b..00000000
--- a/config/03/config.yml
+++ /dev/null
@@ -1,3 +0,0 @@
----
-proxy_mode: Automatic proxy configuration URL
-auto: https://auto.proxy.net/wpad.dat
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
deleted file mode 100644
index ef0a4acd..00000000
--- a/config/03/output_ro.html
+++ /dev/null
@@ -1,8 +0,0 @@
-
╭────────────── 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.yml" (⏳ No proxy)
-┗━━ 📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yml"
-

diff --git a/firefox.png b/firefox.png
index 20701e22..16f5931c 100644
Binary files a/firefox.png and b/firefox.png differ
diff --git a/tree.html b/tree.html
index 570e0f0a..5812b3b4 100644
--- a/tree.html
+++ b/tree.html
@@ -25,15 +25,16 @@
 
 
 	
Directory Tree

-	.

-	└── firefox

-	    ├── 00-proxy.yml

-	    ├── 10-manual.yml

-	    ├── 20-manual.yml

-	    └── 30-auto.yml

+	.

+	└── firefox

+	    ├── 00-proxy.yml

+	    ├── 10-manual.yml

+	    ├── 20-manual.yml

+	    ├── 30-auto.yml

+	    └── 40-no_proxy.yml

 


 
-2 directories, 4 files
+2 directories, 5 files