diff --git a/CHANGELOG.md b/CHANGELOG.md
index 172b74ae..d3377df7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,7 @@
-# New variable
+# New variables
-| Variable | Description |
-|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **foxyproxy.proxies.type**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.
**Choices**:
• HTTP
• HTTPS/SSL
• SOCKS4
• SOCKS5
• PAC URL
• WPAD
• System (use system settings)
• Direct (no proxy) **← (default)** |
+| Variable | Description |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **foxyproxy.proxies.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.
**Validators**:
• type domainname
• the domain name can be a hostname
• the domain name can be an IP
**Default**: copy HTTP address if proxy is not "Manual".
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5. |
+| **foxyproxy.proxies.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | 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**: copy HTTP port if proxy is not "Manual".
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5. |
+| **foxyproxy.proxies.url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | 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
**Default**: copy HTTP address if proxy is "Auto".
**Disabled**: if type is not in:
- PAC URL
- WPAD. |
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index 38bc2a97..a7d5d639 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -96,8 +96,11 @@
> **Path**: foxyproxy.proxies\
> `basic`
-| Variable | Description |
-|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. |
-| **foxyproxy.proxies.type**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.
**Choices**:
• HTTP
• HTTPS/SSL
• SOCKS4
• SOCKS5
• PAC URL
• WPAD
• System (use system settings)
• Direct (no proxy) **← (default)** |
-| **foxyproxy.proxies.color**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: random color value. |
+| Variable | Description |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. |
+| **foxyproxy.proxies.type**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.
**Choices**:
• HTTP
• HTTPS/SSL
• SOCKS4
• SOCKS5
• PAC URL
• WPAD
• System (use system settings)
• Direct (no proxy) **← (default)** |
+| **foxyproxy.proxies.color**
[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.
**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"
**Default**: random color value. |
+| **foxyproxy.proxies.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.
**Validators**:
• type domainname
• the domain name can be a hostname
• the domain name can be an IP
**Default**: copy HTTP address if proxy is not "Manual".
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5. |
+| **foxyproxy.proxies.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | 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**: copy HTTP port if proxy is not "Manual".
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5. |
+| **foxyproxy.proxies.url**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | 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
**Default**: copy HTTP address if proxy is "Auto".
**Disabled**: if type is not in:
- PAC URL
- WPAD. |
diff --git a/README.md b/README.md
index 39d7300d..c3aa4b15 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_182] Auto save value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_182/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_190~1..v1.1_190))
+- [[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_190] A variable name that conflict with a known the variable's attribute "type"
+# [tutorial v1.1_200] Variable calculation with propertyerror
-[Read the tutorial "A variable name that conflict with a known the variable's attribute "type"" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-variable-name-that-conflict-with-a-known-the-variable's-attribute-type)
+[Read the tutorial "Variable calculation with propertyerror" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#variable-calculation-with-propertyerror)
## 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_190
+git switch --detach v1.1_200
```
## 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
@@ -84,6 +84,61 @@ proxies:
#{%- for i in range(6) -%}{{- '0123456789abcdef' | random -}}{%- endfor -%}
description: random color value
auto_save: true
+
+ address:
+ description: IP address, DNS name, server name
+ type: domainname
+ params:
+ allow_ip: true
+ allow_without_dot: true
+ default:
+ description: copy HTTP address if proxy is not "Manual"
+ variable: firefox.manual.http_proxy.address
+ propertyerror: false
+ disabled:
+ jinja: |-
+ {{ _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] }}
+ return_type: boolean
+ description: |-
+ if type not in:
+ - HTTP
+ - HTTPS/SSL
+ - SOCKS4
+ - SOCKS5
+
+ port:
+ description: Port
+ type: port
+ default:
+ description: copy HTTP port if proxy is not "Manual"
+ variable: firefox.manual.http_proxy.port
+ propertyerror: 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
+ default:
+ description: copy HTTP address if proxy is "Auto"
+ variable: firefox.auto
+ propertyerror: false
+ disabled:
+ jinja: |-
+ {{ _.type not in ['PAC URL', 'WPAD'] }}
+ return_type: boolean
+ description: |-
+ if type is not in:
+ - PAC URL
+ - WPAD
...
```
@@ -150,6 +205,8 @@ foxyproxy:
- title: My company
type: HTTP
color: '#66cc66'
+ address: proxy.company.net
+ port: 8080
```
***
@@ -177,6 +234,8 @@ Variables:
- :notebook: title (Title or Description): My 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): #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"
***
### Example 3
@@ -191,17 +250,15 @@ firefox:
manual:
http_proxy:
address: http.proxy.net
+ port: 3128
+ use_for_https: false
+ https_proxy:
+ address: https.proxy.net
foxyproxy:
proxies:
- title: My company
- color: '#66cc66'
type: HTTP
- - title: An other company
- color: '#cc66cc'
- type: SOCKS5
- - title: WPAD
- color: '#1166cc'
- type: WPAD
+ color: '#66cc66'
```
***
@@ -214,7 +271,6 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox
>
> **Caption:**
> - Variable
-> - Unmodifiable variable
> - Default value
> - Modified value
> - (:hourglass_flowing_sand: Original default value)
@@ -225,14 +281,14 @@ 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/03/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
+ - :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): 8080
+ - :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
@@ -245,16 +301,10 @@ Variables:
- :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"
- - :open_file_folder: title (Title or Description)
- - :notebook: title (Title or Description): An other company ← loaded from the YAML file "config/03/config.yml"
- - :notebook: type (Proxy Type): SOCKS5 ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy))
- - :notebook: color (Color): #cc66cc ← loaded from the YAML file "config/03/config.yml"
- - :open_file_folder: title (Title or Description)
- - :notebook: title (Title or Description): WPAD ← loaded from the YAML file "config/03/config.yml"
- - :notebook: type (Proxy Type): WPAD ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy))
- - :notebook: color (Color): #1166cc ← loaded from the YAML file "config/03/config.yml"
+ - :notebook: address (IP address, DNS name, server name): http.proxy.net
+ - :notebook: port (Port): 3128
***
-- [[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_200~1..v1.1_200))
+- [[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))
diff --git a/config/02/config.yml b/config/02/config.yml
index 0780700f..94667928 100644
--- a/config/02/config.yml
+++ b/config/02/config.yml
@@ -4,3 +4,5 @@ foxyproxy:
- title: My company
type: HTTP
color: '#66cc66'
+ address: proxy.company.net
+ port: 8080
diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index db9388b0..383e5e65 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -15,6 +15,11 @@ Variables:
┃ 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
+ ┣━━ 📓 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"
diff --git a/config/03/config.yml b/config/03/config.yml
index 68cc8676..c2a8f35f 100644
--- a/config/03/config.yml
+++ b/config/03/config.yml
@@ -4,14 +4,12 @@ firefox:
manual:
http_proxy:
address: http.proxy.net
+ port: 3128
+ use_for_https: false
+ https_proxy:
+ address: https.proxy.net
foxyproxy:
proxies:
- title: My company
- color: '#66cc66'
type: HTTP
- - title: An other company
- color: '#cc66cc'
- type: SOCKS5
- - title: WPAD
- color: '#1166cc'
- type: WPAD
+ color: '#66cc66'
diff --git a/config/03/output_ro.html b/config/03/output_ro.html
index 57f39aa4..07bae3c4 100644
--- a/config/03/output_ro.html
+++ b/config/03/output_ro.html
@@ -1,8 +1,8 @@
-╭───────────────────── Caption ─────────────────────╮
-│ Variable Default value │
-│ Unmodifiable variable Modified value │
-│ (⏳ Original default value) │
-╰───────────────────────────────────────────────────╯
+╭────────────── Caption ───────────────╮
+│ Variable Default value │
+│ Modified value │
+│ (⏳ Original default value) │
+╰──────────────────────────────────────╯
Variables:
┣━━ 📂 firefox (Firefox)
┃ ┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy
@@ -12,14 +12,17 @@ Variables:
┃ ┃ ┣━━ 📂 http_proxy (HTTP Proxy)
┃ ┃ ┃ ┣━━ 📓 address (HTTP proxy address): http.proxy.net ◀ loaded from
┃ ┃ ┃ ┃ the YAML file "config/03/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
+┃ ┃ ┃ ┗━━ 📓 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): 8080
+┃ ┃ ┣━━ 📓 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
@@ -29,25 +32,13 @@ 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/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"
- ┣━━ 📂 title (Title or Description)
- ┃ ┣━━ 📓 title (Title or Description): An other company ◀ loaded from
- ┃ ┃ the YAML file "config/03/config.yml"
- ┃ ┣━━ 📓 type (Proxy Type): SOCKS5 ◀ loaded from the YAML file
- ┃ ┃ "config/03/config.yml" (⏳ Direct (no proxy))
- ┃ ┗━━ 📓 color (Color): #cc66cc ◀ loaded from the YAML file
- ┃ "config/03/config.yml"
┗━━ 📂 title (Title or Description)
- ┣━━ 📓 title (Title or Description): WPAD ◀ loaded from the YAML
- ┃ file "config/03/config.yml"
- ┣━━ 📓 type (Proxy Type): WPAD ◀ loaded from the YAML file
+ ┣━━ 📓 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): #1166cc ◀ loaded from the YAML file
- "config/03/config.yml"
+ ┣━━ 📓 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
diff --git a/tree.html b/tree.html
index f30aec83..2d3f2693 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