diff --git a/CHANGELOG.md b/CHANGELOG.md
index dca1b1fa..ef55b77f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,8 +1,16 @@
-# Modified variables
+# New variables
-| Variable | Description |
-|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ~~HTTP address.~~
Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP |
-| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | ~~HTTP Port.~~
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.*https*_proxy.address**
**manual.*socks*_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: ~~the value of the variable "[HTTP address](#manual.http_proxy.address)".~~
the value of the variable "[Proxy address](#manual.http_proxy.address)". |
-| **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)".~~
the value of the variable "[Proxy port](#manual.http_proxy.port)". |
+| Variable | Description |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP |
+| **manual.https_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.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | 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` | 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 |
+
+# Deleted variables
+
+- manual.*https*_proxy.address
+- manual.*socks*_proxy.address
+- manual.*https*_proxy.port
+- manual.*socks*_proxy.port
+- manual.*socks*_proxy.version
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index 7e32e902..a3fedf25 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -25,24 +25,26 @@
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true |
-## *HTTPS* or *SOCKS* Proxy
+## HTTPS Proxy
> [!NOTE]
>
-> This family builds families dynamically.\
-> **Path**: \
-> - manual.*https*_proxy\
-
-> - manual.*socks*_proxy\
+> **Path**: manual.https_proxy\
> *`hidden`*\
-> **Hidden**: in HTTPS case if "[Also use this proxy for HTTPS](#manual.use_for_https)" is set to "true".\
-> **Identifiers**: \
-> - HTTPS\
+> **Hidden**: when the variable "[Also use this proxy for HTTPS](#manual.use_for_https)" has the value "true".
-> - SOCKS
+| Variable | Description |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Proxy address.
**Validators**:
• type domainname
• the domain name can be an IP |
+| **manual.https_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 |
-| Variable | Description |
-|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **manual.*https*_proxy.address**
**manual.*socks*_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | *HTTPS* or *SOCKS* address.
**Validators**:
• type domainname
• the domain name can be an IP
**Default**: the value of the variable "[Proxy address](#manual.http_proxy.address)". |
-| **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 "[Proxy port](#manual.http_proxy.port)". |
-| **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". |
+## SOCKS Proxy
+
+> [!NOTE]
+>
+> **Path**: manual.socks_proxy
+
+| Variable | Description |
+|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **manual.socks_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | 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` | 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 |
diff --git a/README.md b/README.md
index bc12ccea..3f8c4bc0 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_073] Jinja could returns a boolean](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_073/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080))
+- [[Previous tutorial v1.1_080] HTTP Proxy with "proxy" type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_081~1..v1.1_081))
-# [tutorial v1.1_080] HTTP Proxy with "proxy" type
+# [tutorial v1.1_081] HTTPS and SOCKS Proxy with "proxy" type
-- [Read the tutorial "HTTP Proxy with "proxy" type" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/customtype.html#http-proxy-with-proxy-type)
-- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080)
+- [Read the tutorial "HTTPS and SOCKS Proxy with "proxy" type" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/customtype.html#https-and-socks-proxy-with-proxy-type)
+- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_081~1..v1.1_081)
## Screenshot
@@ -26,47 +26,23 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
Then switch to the tutorial page:
```shell
-git switch --detach v1.1_080
+git switch --detach v1.1_081
```
## 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 types/proxy/00-type.yml type file
-
-```yml
-%YAML 1.2
----
-version: 1.1
-
-proxy:
-
- address:
- description: Proxy address
- type: domainname
- params:
- allow_ip: true
-
- port:
- description: Proxy port
- type: port
- default: 8080
-...
-
-```
-
-***
-Contents of the firefox/10-manual.yml file
+Contents of the firefox/20-manual.yml file
```yml
%YAML 1.2
@@ -74,13 +50,17 @@ Contents of the firefox/10-manual.yml file
version: 1.1
manual:
- description: Manual proxy configuration
- disabled:
- variable: _.proxy_mode
- when_not: Manual proxy configuration
- http_proxy:
- description: HTTP Proxy
+ use_for_https: true # Also use this proxy for HTTPS
+
+ https_proxy:
+ description: HTTPS Proxy
+ type: proxy
+ hidden:
+ variable: _.use_for_https
+
+ socks_proxy:
+ description: SOCKS Proxy
type: proxy
...
@@ -121,6 +101,8 @@ manual:
use_for_https: false
https_proxy:
address: https.proxy.net
+ socks_proxy:
+ address: socks.proxy.net
```
***
@@ -145,14 +127,13 @@ Variables:
- :notebook: port (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 address): https.proxy.net ← loaded from the YAML file "config/01/config.yml" (:hourglass_flowing_sand: http.proxy.net)
- - :notebook: port (HTTPS port): 3128
+ - :notebook: address (Proxy address): https.proxy.net ← loaded from the YAML file "config/01/config.yml"
+ - :notebook: port (Proxy port): 8080
- :open_file_folder: socks_proxy (SOCKS Proxy)
- - :notebook: address (SOCKS address): http.proxy.net
- - :notebook: port (SOCKS port): 3128
- - :notebook: version (SOCKS host version used by proxy): v5
+ - :notebook: address (Proxy address): socks.proxy.net ← loaded from the YAML file "config/01/config.yml"
+ - :notebook: port (Proxy port): 8080
***
-- [[Next tutorial v1.1_081] HTTPS and SOCKS Proxy with "proxy" type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_081/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_081~1..v1.1_081))
+- [[Next tutorial v1.1_082] Add a variable in a family with custom type](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_082/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_082~1..v1.1_082))
diff --git a/config/01/config.yml b/config/01/config.yml
index 84547faa..06891365 100644
--- a/config/01/config.yml
+++ b/config/01/config.yml
@@ -7,3 +7,5 @@ manual:
use_for_https: false
https_proxy:
address: https.proxy.net
+ socks_proxy:
+ address: socks.proxy.net
diff --git a/config/01/output_ro.html b/config/01/output_ro.html
index 70bc25c3..49c84f18 100644
--- a/config/01/output_ro.html
+++ b/config/01/output_ro.html
@@ -16,11 +16,11 @@ Variables:
┣━━ 📓 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 address): https.proxy.net ◀ loaded from the YAML
- ┃ ┃ file "config/01/config.yml" (⏳ http.proxy.net)
- ┃ ┗━━ 📓 port (HTTPS port): 3128
+ ┃ ┣━━ 📓 address (Proxy address): https.proxy.net ◀ loaded from the YAML
+ ┃ ┃ file "config/01/config.yml"
+ ┃ ┗━━ 📓 port (Proxy port): 8080
┗━━ 📂 socks_proxy (SOCKS Proxy)
- ┣━━ 📓 address (SOCKS address): http.proxy.net
- ┣━━ 📓 port (SOCKS port): 3128
- ┗━━ 📓 version (SOCKS host version used by proxy): v5
+ ┣━━ 📓 address (Proxy address): socks.proxy.net ◀ loaded from the YAML
+ ┃ file "config/01/config.yml"
+ ┗━━ 📓 port (Proxy port): 8080
diff --git a/tree.html b/tree.html
index 74185fe8..d1bd476c 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