diff --git a/CHANGELOG.md b/CHANGELOG.md
index d3377df7..100472e5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,7 +1,6 @@
# New variables
-| 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. |
+| Variable | Description |
+|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| **foxyproxy.proxies.username**
[`UNIX user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* *`disabled`* | Username.
**Mandatory**: if a password is set.
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5. |
+| **foxyproxy.proxies.password**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Password.
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5. |
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index a7d5d639..8770629f 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -96,11 +96,13 @@
> **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. |
-| **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. |
+| 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.username**
[`UNIX user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* *`disabled`* | Username.
**Mandatory**: if a password is set.
**Disabled**: if type not in:
- HTTP
- HTTPS/SSL
- SOCKS4
- SOCKS5. |
+| **foxyproxy.proxies.password**
[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Password.
**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 c3aa4b15..4809fa33 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
╭────────────── 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 + valuediff --git a/tree.html b/tree.html index 2d3f2693..1cdea083 100644 --- a/tree.html +++ b/tree.html @@ -1,17 +1,17 @@-.
\ No newline at end of file
- ├── 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