diff --git a/README.md b/README.md index 009204b..04bac80 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_072] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_072/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072)) +- [[tutorial v1.1_080] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080)) -# [tutorial v1.1_080] A conditional disabled variable with type web_address +# [tutorial v1.1_090] A conditional disabled variable with type domainname and parameters -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-web_address) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-domainname-and-parameters) ## 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_080 +git switch --detach v1.1_090 ``` ## Structure @@ -39,27 +39,33 @@ git switch --detach v1.1_080

-.
- └── 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_not: Automatic proxy configuration URL + when: No proxy ... ``` @@ -115,9 +121,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" | +| 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) `mandatory` *`disabled`* | 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
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | ### Let's generate the changelog @@ -126,9 +133,9 @@ rougail -m firefox/ -o doc --doc.contents changelog ``` #### New variable -| 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" | +| 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**:
• 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
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | ## User datas @@ -140,17 +147,12 @@ 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 ``` -> [!WARNING] -> -> - auto (Automatic proxy configuration URL): :bell: variable has property disabled, it will be ignored when loading from the YAML file "config/01/config.yml" - > [!NOTE] > > **Caption:** @@ -167,30 +169,14 @@ 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 ``` -> [!CAUTION] -> -> - auto (Automatic proxy configuration URL): :stop_sign: mandatory variable but has no value -### 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 -``` > [!NOTE] > > **Caption:** @@ -199,8 +185,9 @@ rougail -m firefox/ -u yaml -yf config/03/config.yml > - (:hourglass_flowing_sand: Original default value) Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): Automatic proxy configuration URL ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: No proxy) -- :notebook: auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat ← loaded from the YAML file "config/03/config.yml" +- :notebook: proxy_mode (Configure Proxy Access to the Internet): Automatic proxy configuration URL ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: No proxy) +- :notebook: auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat ← loaded from the YAML file "config/02/config.yml" +- :notebook: no_proxy (Address for which proxy will be desactivated): 192.168.1.0/24 ← loaded from the YAML file "config/02/config.yml" -- [[tutorial v1.1_090] A conditional disabled variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090)) +- [[tutorial v1.1_091] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_091/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091)) diff --git a/config/01/config.yml b/config/01/config.yml index 1edbe91..ed97d53 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 7f2d108..bb585a6 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,8 +1,4 @@ -
🔔 Warning
-┗━━ auto (Automatic proxy configuration URL): 🔔 variable has property disabled,
-    it will be ignored when loading from the YAML file "config/01/config.yml"
-
-╭─────── Caption ────────╮
+
╭─────── Caption ────────╮
 │ Variable Default value │
 ╰────────────────────────╯
 Variables:
diff --git a/config/02/config.yml b/config/02/config.yml
index 26df130..54956ea 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 3f84fbd..02135a2 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -1,4 +1,13 @@
-
🛑 Caution
-┗━━ auto (Automatic proxy configuration URL): 🛑 mandatory variable but has no 
-    value
+
╭────────────── Caption ───────────────╮
+│ Variable Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Automatic proxy 
+┃   configuration URL ◀ loaded from the YAML file "config/02/config.yml" (⏳ No 
+┃   proxy)
+┣━━ 📓 auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat
+┃   ◀ loaded from the YAML file "config/02/config.yml"
+┗━━ 📓 no_proxy (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 fc8085e..0000000
--- 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 307e175..0000000
--- 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 7fe0059..0000000
--- a/config/03/output_ro.html
+++ /dev/null
@@ -1,11 +0,0 @@
-
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Automatic proxy 
-┃   configuration URL ◀ loaded from the YAML file "config/03/config.yml" (⏳ No 
-┃   proxy)
-┗━━ 📓 auto (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 b7ca7aa..16f5931 100644
Binary files a/firefox.png and b/firefox.png differ
diff --git a/tree.html b/tree.html
index e831ae0..5bee56b 100644
--- a/tree.html
+++ b/tree.html
@@ -1,8 +1,9 @@
 

-.

-	└── 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

 


\ No newline at end of file