diff --git a/CHANGELOG.md b/CHANGELOG.md index 3e456c58..a392392c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,6 @@ # Modified variables -| Variable | Description | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP proxy address](#manual.http_proxy.address)". | -| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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)". | -| **manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | SOCKS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP proxy address](#manual.http_proxy.address)". | -| **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)". | +| 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 | diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 623b6b7e..b4764dd3 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) `mandatory` | SOCKS proxy address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[HTTP proxy address](#manual.http_proxy.address)". | -| **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)". | -| **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` | 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)** | diff --git a/README.md b/README.md index 13b5d275..c4f9bf7c 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_084] Redefine other parameter in custom type for HTTP](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_084/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_085~1..v1.1_085)) +- [[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)) -# [tutorial v1.1_085] Redefine other parameter in custom type for HTTPS and SOCKS +# [tutorial v1.1_090] Variable with the value "null" -- [Read the tutorial "Redefine other parameter in custom type for HTTPS and SOCKS" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/customtype.html#redefine-other-parameter-in-custom-type-for-https-and-socks) -- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_085~1..v1.1_085) +- [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) ## 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_085 +git switch --detach v1.1_090 ``` ## 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 @@ -74,10 +74,13 @@ manual: address: redefine: true description: SOCKS proxy address + default: null + mandatory: false port: redefine: true description: SOCKS proxy port + default: 1080 version: description: SOCKS host version used by proxy @@ -120,10 +123,6 @@ proxy_mode: Manual proxy configuration manual: http_proxy: address: http.proxy.net - port: 3128 - use_for_https: false - https_proxy: - address: https.proxy.net ``` *** @@ -136,6 +135,7 @@ rougail -m firefox/ --types types/proxy -u yaml -yf config/01/config.yml > > **Caption:** > - Variable +> - Unmodifiable variable > - Default value > - Modified value > - (:hourglass_flowing_sand: Original default value) @@ -145,17 +145,17 @@ Variables: - :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/01/config.yml" - - :notebook: port (HTTP proxy port): 3128 ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: 8080) - - :notebook: use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/01/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/01/config.yml" (:hourglass_flowing_sand: http.proxy.net) - - :notebook: port (HTTPS proxy port): 3128 + - :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): http.proxy.net - - :notebook: port (SOCKS proxy port): 3128 + - :notebook: address (SOCKS proxy address): null + - :notebook: port (SOCKS proxy port): 1080 - :notebook: version (SOCKS host version used by proxy): v5 *** -- [[Next 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_090~1..v1.1_090)) +- [[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)) diff --git a/config/01/config.yml b/config/01/config.yml index 84547faa..135d8b3a 100644 --- a/config/01/config.yml +++ b/config/01/config.yml @@ -3,7 +3,3 @@ proxy_mode: Manual proxy configuration manual: http_proxy: address: http.proxy.net - port: 3128 - use_for_https: false - https_proxy: - address: https.proxy.net diff --git a/config/01/output_ro.html b/config/01/output_ro.html index 164ac69c..6f818925 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,8 +1,8 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
+
╭───────────────────── 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/01/config.yml" (⏳ No 
@@ -11,16 +11,13 @@ Variables:
     ┣━━ 📂 http_proxy (HTTP Proxy)
     ┃   ┣━━ 📓 address (HTTP proxy address): http.proxy.net ◀ loaded from the 
     ┃   ┃   YAML file "config/01/config.yml"
-    ┃   ┗━━ 📓 port (HTTP proxy port): 3128 ◀ loaded from the YAML file 
-    ┃       "config/01/config.yml" (⏳ 8080)
-    ┣━━ 📓 use_for_https (Also use this proxy for HTTPS): false ◀ loaded from 
-    ┃   the YAML file "config/01/config.yml" (⏳ true)
-    ┣━━ 📂 https_proxy (HTTPS Proxy)
-    ┃   ┣━━ 📓 address (HTTPS proxy address): https.proxy.net ◀ loaded from the 
-    ┃   ┃   YAML file "config/01/config.yml" (⏳ http.proxy.net)
-    ┃   ┗━━ 📓 port (HTTPS proxy port): 3128
+    ┃   ┗━━ 📓 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): http.proxy.net
-        ┣━━ 📓 port (SOCKS proxy port): 3128
+        ┣━━ 📓 address (SOCKS proxy address): null
+        ┣━━ 📓 port (SOCKS proxy port): 1080
         ┗━━ 📓 version (SOCKS host version used by proxy): v5
 

diff --git a/tree.html b/tree.html
index 598c81ec..4f52b718 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