From bdeb1897fc09a9cf9af133e17b0fd08e6e018cb6 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sat, 18 Apr 2026 21:41:25 +0200 Subject: [PATCH] [tutorial v1.1_210] Username is mandatory if a password is set (config and doc) --- CHANGELOG.md | 3 + README.md | 151 ++++++++++++++++++++++----------------- config/02/config.yml | 6 ++ config/02/output_ro.html | 29 ++++++-- config/03/config.yml | 16 ++--- config/03/output_ro.html | 48 ++----------- tree.html | 30 ++++---- 7 files changed, 145 insertions(+), 138 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bbdb996d..f1546a76 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,3 +40,6 @@ - foxyproxy.proxies.title - foxyproxy.proxies.type - foxyproxy.proxies.color +- foxyproxy.proxies.address +- foxyproxy.proxies.port +- foxyproxy.proxies.url diff --git a/README.md b/README.md index c3aa4b15..33f1c608 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_190] A variable name that conflict with a known the variable's attribute "type"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_200~1..v1.1_200)) +- [[tutorial v1.1_200] Variable calculation with propertyerror](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_210~1..v1.1_210)) -# [tutorial v1.1_200] Variable calculation with propertyerror +# [tutorial v1.1_210] Username is mandatory if a password is set -[Read the tutorial "Variable calculation with propertyerror" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#variable-calculation-with-propertyerror) +[Read the tutorial "Username is mandatory if a password is set" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#username-is-mandatory-if-a-password-is-set) ## Screenshot @@ -25,27 +25,27 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_200 +git switch --detach v1.1_210 ``` ## Structure

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   ├── 20-manual.yml
- │   ├── 30-auto.yml
- │   ├── 40-no_proxy.yml
- │   ├── 50-prompt_authentication.yml
- │   ├── 55-proxy_dns_socks5.yml
- │   └── 60-dns_over_https.yml
- ├── foxyproxy
- │   └── 00-foxyproxy.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
+ │   ├── 55-proxy_dns_socks5.yml
+ │   └── 60-dns_over_https.yml
+ ├── foxyproxy
+ │   └── 00-foxyproxy.yml
+ └── types
+     └── proxy
+         └── 00-type.yml


Contents of the foxyproxy/00-foxyproxy.yml file @@ -124,6 +124,44 @@ proxies: - SOCKS4 - SOCKS5 + username: + description: Username + type: unix_user + mandatory: + jinja: |- + {% if _.password is not propertyerror and _.password %} + true + {% else %} + false + {% endif %} + return_type: boolean + description: if a password is set + disabled: + jinja: |- + {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} + return_type: boolean + description: |- + if type not in: + - HTTP + - HTTPS/SSL + - SOCKS4 + - SOCKS5 + + password: + description: Password + type: secret + mandatory: false + disabled: + jinja: |- + {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }} + return_type: boolean + description: |- + if type not in: + - HTTP + - HTTPS/SSL + - SOCKS4 + - SOCKS5 + url: description: URL type: web_address @@ -207,6 +245,12 @@ foxyproxy: color: '#66cc66' address: proxy.company.net port: 8080 + username: one_user + password: P4ssW0rD + - title: An other company + type: HTTP + address: proxy.company.net + port: 8080 ``` *** @@ -236,6 +280,16 @@ Variables: - :notebook: color (Color): #66cc66 ← loaded from the YAML file "config/02/config.yml" - :notebook: address (IP address, DNS name, server name): proxy.company.net ← loaded from the YAML file "config/02/config.yml" - :notebook: port (Port): 8080 ← loaded from the YAML file "config/02/config.yml" + - :notebook: username (Username): one_user ← loaded from the YAML file "config/02/config.yml" + - :notebook: password (Password): ********** ← loaded from the YAML file "config/02/config.yml" + - :open_file_folder: title (Title or Description) + - :notebook: title (Title or Description): An other company ← loaded from the YAML file "config/02/config.yml" + - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) + - :notebook: color (Color): #c1e393 + - :notebook: address (IP address, DNS name, server name): proxy.company.net ← loaded from the YAML file "config/02/config.yml" + - :notebook: port (Port): 8080 ← loaded from the YAML file "config/02/config.yml" + - :notebook: username (Username): null + - :notebook: password (Password): null *** ### Example 3 @@ -245,20 +299,18 @@ Variables: ```yml --- -firefox: - proxy_mode: Manual proxy configuration - manual: - http_proxy: - address: http.proxy.net - port: 3128 - use_for_https: false - https_proxy: - address: https.proxy.net foxyproxy: proxies: - title: My company type: HTTP color: '#66cc66' + address: proxy.company.net + port: 8080 + password: P4ssW0rD + - title: An other company + type: HTTP + address: proxy.company.net + port: 8080 ``` *** @@ -267,44 +319,13 @@ foxyproxy: ```shell rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/03/config.yml ``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :open_file_folder: firefox (Firefox) - - :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 proxy address): http.proxy.net ← loaded from the YAML file "config/03/config.yml" - - :notebook: port (HTTP proxy port): 3128 ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: 8080) - - :notebook: use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: true) - - :open_file_folder: https_proxy (HTTPS Proxy) - - :notebook: address (HTTPS proxy address): https.proxy.net ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: http.proxy.net) - - :notebook: port (HTTPS proxy port): 3128 - - :open_file_folder: socks_proxy (SOCKS Proxy) - - :notebook: address (SOCKS proxy address): http.proxy.net - - :notebook: port (SOCKS proxy port): 3128 - - :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 - - :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false - - :open_file_folder: dns_over_https (DNS over HTTPS) - - :notebook: enable_dns_over_https (Enable DNS over HTTPS): false -- :open_file_folder: foxyproxy (FoxyProxy) - - :open_file_folder: proxies (Proxy configuration) - - :open_file_folder: title (Title or Description) - - :notebook: title (Title or Description): My company ← loaded from the YAML file "config/03/config.yml" - - :notebook: type (Proxy Type): HTTP ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy)) - - :notebook: color (Color): #66cc66 ← loaded from the YAML file "config/03/config.yml" - - :notebook: address (IP address, DNS name, server name): http.proxy.net - - :notebook: port (Port): 3128 +> [!CAUTION] +> +> - foxyproxy (FoxyProxy) +> - proxies (Proxy configuration) +> - username (Username): :stop_sign: mandatory variable at index "0" but has no value *** -- [[tutorial v1.1_210] Username is mandatory if a password is set](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_210/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_210~1..v1.1_210)) +- [[tutorial v1.1_211] redefines the behavior to password mandatory if the user is defined](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_211/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_211~1..v1.1_211)) diff --git a/config/02/config.yml b/config/02/config.yml index 94667928..0e0d4b33 100644 --- a/config/02/config.yml +++ b/config/02/config.yml @@ -6,3 +6,9 @@ foxyproxy: color: '#66cc66' address: proxy.company.net port: 8080 + username: one_user + password: P4ssW0rD + - title: An other company + type: HTTP + address: proxy.company.net + port: 8080 diff --git a/config/02/output_ro.html b/config/02/output_ro.html index 383e5e65..76a458c6 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -10,16 +10,33 @@ Variables: ┃ ┗━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): false ┗━━ 📂 foxyproxy (FoxyProxy) ┗━━ 📂 proxies (Proxy configuration) + ┣━━ 📂 title (Title or Description) + ┃ ┣━━ 📓 title (Title or Description): My company ◀ loaded from the + ┃ ┃ YAML file "config/02/config.yml" + ┃ ┣━━ 📓 type (Proxy Type): HTTP ◀ loaded from the YAML file + ┃ ┃ "config/02/config.yml" (⏳ Direct (no proxy)) + ┃ ┣━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file + ┃ ┃ "config/02/config.yml" + ┃ ┣━━ 📓 address (IP address, DNS name, server name): + ┃ ┃ proxy.company.net ◀ loaded from the YAML file + ┃ ┃ "config/02/config.yml" + ┃ ┣━━ 📓 port (Port): 8080 ◀ loaded from the YAML file + ┃ ┃ "config/02/config.yml" + ┃ ┣━━ 📓 username (Username): one_user ◀ loaded from the YAML file + ┃ ┃ "config/02/config.yml" + ┃ ┗━━ 📓 password (Password): ********** ◀ loaded from the YAML file + ┃ "config/02/config.yml" ┗━━ 📂 title (Title or Description) - ┣━━ 📓 title (Title or Description): My company ◀ loaded from the - ┃ YAML file "config/02/config.yml" + ┣━━ 📓 title (Title or Description): An other company ◀ loaded from + ┃ the YAML file "config/02/config.yml" ┣━━ 📓 type (Proxy Type): HTTP ◀ loaded from the YAML file ┃ "config/02/config.yml" (⏳ Direct (no proxy)) - ┣━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file - ┃ "config/02/config.yml" + ┣━━ 📓 color (Color): #c1e393 ┣━━ 📓 address (IP address, DNS name, server name): ┃ proxy.company.net ◀ loaded from the YAML file ┃ "config/02/config.yml" - ┗━━ 📓 port (Port): 8080 ◀ loaded from the YAML file - "config/02/config.yml" + ┣━━ 📓 port (Port): 8080 ◀ loaded from the YAML file + ┃ "config/02/config.yml" + ┣━━ 📓 username (Username): null + ┗━━ 📓 password (Password): null diff --git a/config/03/config.yml b/config/03/config.yml index c2a8f35f..48b8f490 100644 --- a/config/03/config.yml +++ b/config/03/config.yml @@ -1,15 +1,13 @@ --- -firefox: - proxy_mode: Manual proxy configuration - manual: - http_proxy: - address: http.proxy.net - port: 3128 - use_for_https: false - https_proxy: - address: https.proxy.net foxyproxy: proxies: - title: My company type: HTTP color: '#66cc66' + address: proxy.company.net + port: 8080 + password: P4ssW0rD + - title: An other company + type: HTTP + address: proxy.company.net + port: 8080 diff --git a/config/03/output_ro.html b/config/03/output_ro.html index 07bae3c4..c21d5c74 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,44 +1,6 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📂 firefox (Firefox)
-┃   ┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
-┃   ┃   configuration ◀ loaded from the YAML file "config/03/config.yml" (⏳ No 
-┃   ┃   proxy)
-┃   ┣━━ 📂 manual (Manual proxy configuration)
-┃   ┃   ┣━━ 📂 http_proxy (HTTP Proxy)
-┃   ┃   ┃   ┣━━ 📓 address (HTTP proxy address): http.proxy.net ◀ loaded from 
-┃   ┃   ┃   ┃   the YAML file "config/03/config.yml"
-┃   ┃   ┃   ┗━━ 📓 port (HTTP proxy port): 3128 ◀ loaded from the YAML file 
-┃   ┃   ┃       "config/03/config.yml" (⏳ 8080)
-┃   ┃   ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): false ◀ loaded 
-┃   ┃   ┃   from the YAML file "config/03/config.yml" (⏳ true)
-┃   ┃   ┣━━ 📂 https_proxy (HTTPS Proxy)
-┃   ┃   ┃   ┣━━ 📓 address (HTTPS proxy address): https.proxy.net ◀ loaded from 
-┃   ┃   ┃   ┃   the YAML file "config/03/config.yml" (⏳ http.proxy.net)
-┃   ┃   ┃   ┗━━ 📓 port (HTTPS proxy port): 3128
-┃   ┃   ┗━━ 📂 socks_proxy (SOCKS Proxy)
-┃   ┃       ┣━━ 📓 address (SOCKS proxy address): http.proxy.net
-┃   ┃       ┣━━ 📓 port (SOCKS proxy port): 3128
-┃   ┃       ┗━━ 📓 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
-┃   ┣━━ 📓 proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): false
-┃   ┗━━ 📂 dns_over_https (DNS over HTTPS)
-┃       ┗━━ 📓 enable_dns_over_https (Enable DNS over HTTPS): false
-┗━━ 📂 foxyproxy (FoxyProxy)
-    ┗━━ 📂 proxies (Proxy configuration)
-        ┗━━ 📂 title (Title or Description)
-            ┣━━ 📓 title (Title or Description): My company ◀ loaded from the 
-            ┃   YAML file "config/03/config.yml"
-            ┣━━ 📓 type (Proxy Type): HTTP ◀ loaded from the YAML file 
-            ┃   "config/03/config.yml" (⏳ Direct (no proxy))
-            ┣━━ 📓 color (Color): #66cc66 ◀ loaded from the YAML file 
-            ┃   "config/03/config.yml"
-            ┣━━ 📓 address (IP address, DNS name, server name): http.proxy.net
-            ┗━━ 📓 port (Port): 3128
+
🛑 Caution
+┗━━ foxyproxy (FoxyProxy)
+    ┗━━ proxies (Proxy configuration)
+        ┗━━ username (Username): 🛑 mandatory variable at index "0" but has no 
+            value
 

diff --git a/tree.html b/tree.html
index 2d3f2693..1cdea083 100644
--- a/tree.html
+++ b/tree.html
@@ -1,17 +1,17 @@
 

-.

-	├── firefox

-	│   ├── 00-proxy.yml

-	│   ├── 10-manual.yml

-	│   ├── 20-manual.yml

-	│   ├── 30-auto.yml

-	│   ├── 40-no_proxy.yml

-	│   ├── 50-prompt_authentication.yml

-	│   ├── 55-proxy_dns_socks5.yml

-	│   └── 60-dns_over_https.yml

-	├── foxyproxy

-	│   └── 00-foxyproxy.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

+	│   ├── 55-proxy_dns_socks5.yml

+	│   └── 60-dns_over_https.yml

+	├── foxyproxy

+	│   └── 00-foxyproxy.yml

+	└── types

+	    └── proxy

+	        └── 00-type.yml

 


\ No newline at end of file