diff --git a/CHANGELOG.md b/CHANGELOG.md index a392392c..de43a07d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Modified variables -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.socks_proxy.address**
~~`mandatory`~~ [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | SOCKS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP | -| **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS 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**: ~~the value of the variable "[HTTP proxy port](#manual.http_proxy.port)".~~
1080 | +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS 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**: 1080
**Disabled**: when the variable "[SOCKS proxy address](#manual.socks_proxy.address)" has the value "null". | +| **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 variable "[SOCKS proxy address](#manual.socks_proxy.address)" has the value "null". | diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index b4764dd3..61718dbf 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -44,8 +44,8 @@ > > **Path**: manual.socks_proxy -| Variable | Description | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | SOCKS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP | -| **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS 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**: 1080 | -| **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 | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | SOCKS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP | +| **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | SOCKS 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**: 1080
**Disabled**: when the variable "[SOCKS proxy address](#manual.socks_proxy.address)" has the value "null". | +| **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 variable "[SOCKS proxy address](#manual.socks_proxy.address)" has the value "null". | diff --git a/README.md b/README.md index c4f9bf7c..31c3d8df 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ - [List of all the tutorial steps](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[Previous tutorial v1.1_085] Redefine other parameter in custom type for HTTPS and SOCKS](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_085/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090)) +- [[Previous tutorial v1.1_090] Variable with the value "null"](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_091~1..v1.1_091)) -# [tutorial v1.1_090] Variable with the value "null" +# [tutorial v1.1_091] Variables disabled when condition is null -- [Read the tutorial "Variable with the value "null"" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#variable-with-the-value-null) -- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090) +- [Read the tutorial "Variables disabled when condition is null" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#variables-disabled-when-condition-is-null) +- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091) ## Screenshot @@ -26,20 +26,20 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_090 +git switch --detach v1.1_091 ``` ## Structure

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   └── 20-manual.yml
- └── types
-     └── proxy
-         └── 00-type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   └── 20-manual.yml
+ └── types
+     └── proxy
+         └── 00-type.yml


Contents of the firefox/20-manual.yml file @@ -81,6 +81,9 @@ manual: redefine: true description: SOCKS proxy port default: 1080 + disabled: + variable: _.address + when: null version: description: SOCKS host version used by proxy @@ -88,6 +91,9 @@ manual: - v4 - v5 default: v5 + disabled: + variable: _.address + when: null ... ``` @@ -152,10 +158,57 @@ Variables: - :notebook: port (HTTPS proxy port): 8080 - :open_file_folder: socks_proxy (SOCKS Proxy) - :notebook: address (SOCKS proxy address): null - - :notebook: port (SOCKS proxy port): 1080 - - :notebook: version (SOCKS host version used by proxy): v5 + +*** +### Example 2 + +#### config/02/config.yml + + +```yml +--- +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: http.proxy.net + socks_proxy: + adress: socks.proxy.net +``` + +*** +#### Output + +```shell +rougail -m firefox/ --types types/proxy -u yaml -yf config/02/config.yml +``` +> [!WARNING] +> +> - manual (Manual proxy configuration) +> - socks_proxy (SOCKS Proxy): :bell: variable or family "adress" does not exist so cannot load "manual.socks_proxy.adress", it will be ignored when loading from the YAML file "config/02/config.yml" + +> [!NOTE] +> +> **Caption:** +> - Variable +> - Unmodifiable 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/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 proxy address): http.proxy.net ← loaded from the YAML file "config/02/config.yml" + - :notebook: port (HTTP proxy port): 8080 + - :notebook: use_for_https (Also use this proxy for HTTPS): true + - :open_file_folder: https_proxy (HTTPS Proxy) + - :notebook: address (HTTPS proxy address): http.proxy.net + - :notebook: port (HTTPS proxy port): 8080 + - :open_file_folder: socks_proxy (SOCKS Proxy) + - :notebook: address (SOCKS proxy address): null *** -- [[Next tutorial v1.1_091] Variables disabled when condition is null](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)) +- [[Next tutorial v1.1_100] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 6f818925..ae974ea7 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -17,7 +17,5 @@ Variables: ┃ ┣━━ 📓 address (HTTPS proxy address): http.proxy.net ┃ ┗━━ 📓 port (HTTPS proxy port): 8080 ┗━━ 📂 socks_proxy (SOCKS Proxy) - ┣━━ 📓 address (SOCKS proxy address): null - ┣━━ 📓 port (SOCKS proxy port): 1080 - ┗━━ 📓 version (SOCKS host version used by proxy): v5 + ┗━━ 📓 address (SOCKS proxy address): null diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt new file mode 100644 index 00000000..4a6cdd4e --- /dev/null +++ b/config/02/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ --types types/proxy -u yaml -yf config/02/config.yml \ No newline at end of file diff --git a/config/02/config.yml b/config/02/config.yml new file mode 100644 index 00000000..6615aaf9 --- /dev/null +++ b/config/02/config.yml @@ -0,0 +1,7 @@ +--- +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: http.proxy.net + socks_proxy: + adress: socks.proxy.net diff --git a/config/02/output_ro.html b/config/02/output_ro.html new file mode 100644 index 00000000..fc567655 --- /dev/null +++ b/config/02/output_ro.html @@ -0,0 +1,27 @@ +
🔔 Warning
+┗━━ manual (Manual proxy configuration)
+    ┗━━ socks_proxy (SOCKS Proxy): 🔔 variable or family "adress" does not exist
+        so cannot load "manual.socks_proxy.adress", it will be ignored when 
+        loading from the YAML file "config/02/config.yml"
+
+╭───────────────────── Caption ─────────────────────╮
+│ Variable              Default value               │
+│ Unmodifiable variable Modified value              │
+│                       (⏳ Original default value) │
+╰───────────────────────────────────────────────────╯
+Variables:
+┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy 
+┃   configuration ◀ loaded from the YAML file "config/02/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/02/config.yml"
+    ┃   ┗━━ 📓 port (HTTP proxy port): 8080
+    ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): true
+    ┣━━ 📂 https_proxy (HTTPS Proxy)
+    ┃   ┣━━ 📓 address (HTTPS proxy address): http.proxy.net
+    ┃   ┗━━ 📓 port (HTTPS proxy port): 8080
+    ┗━━ 📂 socks_proxy (SOCKS Proxy)
+        ┗━━ 📓 address (SOCKS proxy address): null
+
diff --git a/tree.html b/tree.html index 4f52b718..e5b4f703 100644 --- a/tree.html +++ b/tree.html @@ -1,10 +1,10 @@

-.
- ├── firefox
- │   ├── 00-proxy.yml
- │   ├── 10-manual.yml
- │   └── 20-manual.yml
- └── types
-     └── proxy
-         └── 00-type.yml
+.
+ ├── firefox
+ │   ├── 00-proxy.yml
+ │   ├── 10-manual.yml
+ │   └── 20-manual.yml
+ └── types
+     └── proxy
+         └── 00-type.yml


\ No newline at end of file