diff --git a/README.md b/README.md index 528c7850..94748f42 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_103] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_104~1..v1.1_104)) +- [[tutorial v1.1_104] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_104/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110)) -# [tutorial v1.1_104] Help +# [tutorial v1.1_110] A conditional disabled boolean variable -[Read the tutorial "Help" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#help) +[Read the tutorial "A conditional disabled boolean variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-conditional-disabled-boolean-variable) ## 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_104 +git switch --detach v1.1_110 ``` ## Structure @@ -37,40 +37,29 @@ git switch --detach v1.1_104

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   └── 40-no_proxy.yml
- └── types
-     └── proxy
-         └── 00_type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   ├── 20-manual.yml
+ │   ├── 30-auto.yml
+ │   ├── 40-no_proxy.yml
+ │   └── 50-prompt_authentication.yml
+ └── types
+     └── proxy
+         └── 00_type.yml


-Contents of the firefox/40-no_proxy.yml file +Contents of the firefox/50-prompt_authentication.yml file ```yml %YAML 1.2 --- 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 - - 192.168.1.0/24 - type: domainname - params: - allow_ip: true - allow_cidr_network: true - allow_without_dot: true - allow_startswith_dot: true - multi: true - mandatory: false +prompt_authentication: + description: Prompt for authentication if password is saved + default: true disabled: variable: _.proxy_mode when: No proxy @@ -136,10 +125,11 @@ rougail -m firefox/ --types types/proxy -o doc | **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy 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**: 8080 | | **manual.socks_proxy.version**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS host version used by proxy.
**Choices**:
• v4
• v5 **← (default)** | -| 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" | +| 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" | +| **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 "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | *** @@ -148,11 +138,11 @@ rougail -m firefox/ --types types/proxy -o doc ```shell rougail -m firefox/ --types types/proxy -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml ``` -#### Modified variable +#### New 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.
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" | +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **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 "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy" | *** @@ -190,8 +180,10 @@ Variables: ```yml --- -proxy_mode: Automatic proxy configuration URL -auto: https://auto.proxy.net/wpad.dat +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: http.proxy.net ``` *** @@ -200,18 +192,11 @@ auto: https://auto.proxy.net/wpad.dat ```shell rougail -m firefox/ --types types/proxy -u yaml -yf config/02/config.yml ``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value -> - Modified value -> - (: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/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): [] +> [!CAUTION] +> +> - manual (Manual proxy configuration) +> - socks_proxy (SOCKS Proxy) +> - address (Proxy address): :stop_sign: mandatory variable but has no value *** ### Example 3 @@ -221,11 +206,11 @@ Variables: ```yml --- -proxy_mode: Automatic proxy configuration URL -auto: https://auto.proxy.net/wpad.dat -no_proxy: - - .example.net - - 192.168.1.0/24 +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: http.proxy.net +proxy_dns_socks5: true ``` *** @@ -234,21 +219,42 @@ no_proxy: ```shell rougail -m firefox/ --types types/proxy -u yaml -yf config/03/config.yml ``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Modified value -> - (:hourglass_flowing_sand: Original default value) +> [!CAUTION] +> +> - variable or family "proxy_dns_socks5" does not exist so cannot load "proxy_dns_socks5", it will be ignored when loading from the YAML file "config/03/config.yml" +> - manual (Manual proxy configuration) +> - socks_proxy (SOCKS Proxy) +> - address (Proxy address): :stop_sign: mandatory variable but has no 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: no_proxy (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" +*** +### Example 4 + +#### config/04/config.yml + + +```yml +--- +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: http.proxy.net + socks_proxy: + version: v4 +``` + +*** +#### Output + +```shell +rougail -m firefox/ --types types/proxy -u yaml -yf config/04/config.yml +``` +> [!CAUTION] +> +> - manual (Manual proxy configuration) +> - socks_proxy (SOCKS Proxy) +> - address (Proxy address): :stop_sign: mandatory variable but has no value *** -- [[tutorial v1.1_110] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110)) +- [[tutorial v1.1_111] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111)) diff --git a/config/02/config.yml b/config/02/config.yml index 307e175b..135d8b3a 100644 --- a/config/02/config.yml +++ b/config/02/config.yml @@ -1,3 +1,5 @@ --- -proxy_mode: Automatic proxy configuration URL -auto: https://auto.proxy.net/wpad.dat +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: http.proxy.net diff --git a/config/02/output_ro.html b/config/02/output_ro.html index 661ecbb3..26749f46 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,13 +1,5 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          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): []
+
🛑 Caution
+┗━━ manual (Manual proxy configuration)
+    ┗━━ socks_proxy (SOCKS Proxy)
+        ┗━━ address (Proxy address): 🛑 mandatory variable but has no value
 

diff --git a/config/03/config.yml b/config/03/config.yml
index 53198970..d04e72ce 100644
--- a/config/03/config.yml
+++ b/config/03/config.yml
@@ -1,6 +1,6 @@
 ---
-proxy_mode: Automatic proxy configuration URL
-auto: https://auto.proxy.net/wpad.dat
-no_proxy:
-  - .example.net
-  - 192.168.1.0/24
+proxy_mode: Manual proxy configuration
+manual:
+  http_proxy:
+    address: http.proxy.net
+proxy_dns_socks5: true
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index f35b2ad7..b22a8379 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -1,14 +1,8 @@
-
╭────────────── 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"
-┗━━ 📓 no_proxy (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"
+
🛑 Caution
+┣━━ variable or family "proxy_dns_socks5" does not exist so cannot load 
+┃   "proxy_dns_socks5", it will be ignored when loading from the YAML file 
+┃   "config/03/config.yml"
+┗━━ manual (Manual proxy configuration)
+    ┗━━ socks_proxy (SOCKS Proxy)
+        ┗━━ address (Proxy address): 🛑 mandatory variable but has no value
 

diff --git a/config/04/cmd_ro.txt b/config/04/cmd_ro.txt
new file mode 100644
index 00000000..b29c9f32
--- /dev/null
+++ b/config/04/cmd_ro.txt
@@ -0,0 +1 @@
+rougail -m firefox/ --types types/proxy -u yaml -yf config/04/config.yml
\ No newline at end of file
diff --git a/config/04/config.yml b/config/04/config.yml
new file mode 100644
index 00000000..8ceca7bc
--- /dev/null
+++ b/config/04/config.yml
@@ -0,0 +1,7 @@
+---
+proxy_mode: Manual proxy configuration
+manual:
+  http_proxy:
+    address: http.proxy.net
+  socks_proxy:
+    version: v4
diff --git a/config/04/output_ro.html b/config/04/output_ro.html
new file mode 100644
index 00000000..26749f46
--- /dev/null
+++ b/config/04/output_ro.html
@@ -0,0 +1,5 @@
+
🛑 Caution
+┗━━ manual (Manual proxy configuration)
+    ┗━━ socks_proxy (SOCKS Proxy)
+        ┗━━ address (Proxy address): 🛑 mandatory variable but has no value
+

diff --git a/firefox.png b/firefox.png
index 16f5931c..34e6c084 100644
Binary files a/firefox.png and b/firefox.png differ
diff --git a/tree.html b/tree.html
index 1743f63f..95cc6f03 100644
--- a/tree.html
+++ b/tree.html
@@ -1,12 +1,13 @@
 

-.

-	├── firefox

-	│   ├── 00-proxy.yml

-	│   ├── 10-manual.yml

-	│   ├── 20-manual.yml

-	│   ├── 30-auto.yml

-	│   └── 40-no_proxy.yml

-	└── types

-	    └── proxy

-	        └── 00_type.yml

+.

+	├── firefox

+	│   ├── 00-proxy.yml

+	│   ├── 10-manual.yml

+	│   ├── 20-manual.yml

+	│   ├── 30-auto.yml

+	│   ├── 40-no_proxy.yml

+	│   └── 50-prompt_authentication.yml

+	└── types

+	    └── proxy

+	        └── 00_type.yml

 


\ No newline at end of file