diff --git a/README.md b/README.md index 777ef59..da818be 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_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_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_094] Help +# [tutorial v1.1_095] A conditional disabled boolean variable -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_094~1..v1.1_094) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_095~1..v1.1_095) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#help) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-boolean-variable) ## 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_094 +git switch --detach v1.1_095 ``` ## Structure @@ -39,37 +39,26 @@ git switch --detach v1.1_094

-.
- └── 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
+     └── 50-prompt_authentication.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 @@ -130,10 +119,11 @@ 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.
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" | *** @@ -142,11 +132,11 @@ rougail -m firefox/ -o doc ```shell rougail -m firefox/ -o doc --doc.contents changelog ``` -#### 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" | *** @@ -184,8 +174,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 ``` *** @@ -203,9 +195,18 @@ rougail -m firefox/ -u yaml -yf config/02/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/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: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: No proxy) +- :open_file_folder: manual (Manual proxy configuration) + - :open_file_folder: http_proxy (HTTP Proxy) + - :notebook: address (HTTP address): http.proxy.net ← loaded from the YAML file "config/02/config.yml" + - :notebook: port (HTTP Port): 8080 + - :notebook: use_for_https (Also use this proxy for HTTPS): true + - :open_file_folder: socks_proxy (SOCKS Proxy) + - :notebook: address (SOCKS address): http.proxy.net + - :notebook: port (SOCKS port): 8080 + - :notebook: version (SOCKS host version used by proxy): v5 - :notebook: no_proxy (Address for which proxy will be desactivated): [] +- :notebook: prompt_authentication (Prompt for authentication if password is saved): true *** ### Example 3 @@ -215,11 +216,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 ``` *** @@ -228,21 +229,77 @@ no_proxy: ```shell rougail -m firefox/ -u yaml -yf config/03/config.yml ``` +> [!WARNING] +> +> - variable or family "proxy_dns_socks5" does not exist, it will be ignored when loading from the YAML file "config/03/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/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" +- :notebook: proxy_mode (Configure Proxy Access to the Internet): Manual proxy configuration ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: No proxy) +- :open_file_folder: manual (Manual proxy configuration) + - :open_file_folder: http_proxy (HTTP Proxy) + - :notebook: address (HTTP address): http.proxy.net ← loaded from the YAML file "config/03/config.yml" + - :notebook: port (HTTP Port): 8080 + - :notebook: use_for_https (Also use this proxy for HTTPS): true + - :open_file_folder: socks_proxy (SOCKS Proxy) + - :notebook: address (SOCKS address): http.proxy.net + - :notebook: port (SOCKS port): 8080 + - :notebook: version (SOCKS host version used by proxy): v5 +- :notebook: no_proxy (Address for which proxy will be desactivated): [] +- :notebook: prompt_authentication (Prompt for authentication if password is saved): true + +*** +### 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/ -u yaml -yf config/04/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): Manual proxy configuration ← loaded from the YAML file "config/04/config.yml" (:hourglass_flowing_sand: No proxy) +- :open_file_folder: manual (Manual proxy configuration) + - :open_file_folder: http_proxy (HTTP Proxy) + - :notebook: address (HTTP address): http.proxy.net ← loaded from the YAML file "config/04/config.yml" + - :notebook: port (HTTP Port): 8080 + - :notebook: use_for_https (Also use this proxy for HTTPS): true + - :open_file_folder: socks_proxy (SOCKS Proxy) + - :notebook: address (SOCKS address): http.proxy.net + - :notebook: port (SOCKS port): 8080 + - :notebook: version (SOCKS host version used by proxy): v4 ← loaded from the YAML file "config/04/config.yml" (:hourglass_flowing_sand: v5) +- :notebook: no_proxy (Address for which proxy will be desactivated): [] +- :notebook: prompt_authentication (Prompt for authentication if password is saved): true *** -- [[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)) +- [[tutorial v1.1_096] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_096/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_096~1..v1.1_096)) diff --git a/config/02/config.yml b/config/02/config.yml index 307e175..135d8b3 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 661ecbb..6c879e1 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -4,10 +4,20 @@ │ (⏳ 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_mode (Configure Proxy Access to the Internet): Manual proxy +┃ configuration ◀ 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): [] +┣━━ 📂 manual (Manual proxy configuration) +┃ ┣━━ 📂 http_proxy (HTTP Proxy) +┃ ┃ ┣━━ 📓 address (HTTP address): http.proxy.net ◀ loaded from the YAML +┃ ┃ ┃ file "config/02/config.yml" +┃ ┃ ┗━━ 📓 port (HTTP Port): 8080 +┃ ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): true +┃ ┗━━ 📂 socks_proxy (SOCKS Proxy) +┃ ┣━━ 📓 address (SOCKS address): http.proxy.net +┃ ┣━━ 📓 port (SOCKS port): 8080 +┃ ┗━━ 📓 version (SOCKS host version used by proxy): v5 +┣━━ 📓 no_proxy (Address for which proxy will be desactivated): [] +┗━━ 📓 prompt_authentication (Prompt for authentication if password is saved): + true diff --git a/config/03/config.yml b/config/03/config.yml index 5319897..d04e72c 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 f35b2ad..b4566c7 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,14 +1,27 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Modified value              │
+
🔔 Warning
+┗━━ variable or family "proxy_dns_socks5" does not exist, it will be ignored 
+    when loading from the YAML file "config/03/config.yml"
+
+╭────────────── 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/03/config.yml" (⏳ No 
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
+┃   configuration ◀ 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"
+┣━━ 📂 manual (Manual proxy configuration)
+┃   ┣━━ 📂 http_proxy (HTTP Proxy)
+┃   ┃   ┣━━ 📓 address (HTTP address): http.proxy.net ◀ loaded from the YAML 
+┃   ┃   ┃   file "config/03/config.yml"
+┃   ┃   ┗━━ 📓 port (HTTP Port): 8080
+┃   ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): true
+┃   ┗━━ 📂 socks_proxy (SOCKS Proxy)
+┃       ┣━━ 📓 address (SOCKS address): http.proxy.net
+┃       ┣━━ 📓 port (SOCKS port): 8080
+┃       ┗━━ 📓 version (SOCKS host version used by proxy): v5
+┣━━ 📓 no_proxy (Address for which proxy will be desactivated): []
+┗━━ 📓 prompt_authentication (Prompt for authentication if password is saved): 
+    true
 

diff --git a/config/04/cmd_ro.txt b/config/04/cmd_ro.txt
new file mode 100644
index 0000000..4d43eae
--- /dev/null
+++ b/config/04/cmd_ro.txt
@@ -0,0 +1 @@
+rougail -m firefox/ -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 0000000..8ceca7b
--- /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 0000000..7ec8110
--- /dev/null
+++ b/config/04/output_ro.html
@@ -0,0 +1,24 @@
+
╭────────────── Caption ───────────────╮
+│ Variable Default value               │
+│          Modified value              │
+│          (⏳ Original default value) │
+╰──────────────────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
+┃   configuration ◀ loaded from the YAML file "config/04/config.yml" (⏳ No 
+┃   proxy)
+┣━━ 📂 manual (Manual proxy configuration)
+┃   ┣━━ 📂 http_proxy (HTTP Proxy)
+┃   ┃   ┣━━ 📓 address (HTTP address): http.proxy.net ◀ loaded from the YAML 
+┃   ┃   ┃   file "config/04/config.yml"
+┃   ┃   ┗━━ 📓 port (HTTP Port): 8080
+┃   ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): true
+┃   ┗━━ 📂 socks_proxy (SOCKS Proxy)
+┃       ┣━━ 📓 address (SOCKS address): http.proxy.net
+┃       ┣━━ 📓 port (SOCKS port): 8080
+┃       ┗━━ 📓 version (SOCKS host version used by proxy): v4 ◀ loaded from the 
+┃           YAML file "config/04/config.yml" (⏳ v5)
+┣━━ 📓 no_proxy (Address for which proxy will be desactivated): []
+┗━━ 📓 prompt_authentication (Prompt for authentication if password is saved): 
+    true
+

diff --git a/firefox.png b/firefox.png
index 16f5931..34e6c08 100644
Binary files a/firefox.png and b/firefox.png differ
diff --git a/tree.html b/tree.html
index 1f7c571..f47197f 100644
--- a/tree.html
+++ b/tree.html
@@ -1,9 +1,10 @@
 

-.

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

+	    └── 50-prompt_authentication.yml

 


\ No newline at end of file