diff --git a/README.md b/README.md
index 65bd1ea..7c0d788 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 102] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_102/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_102~1..v1.1_102))
+- [[tutorial 103] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103))
-# [tutorial 103] xxx
+# [tutorial 104] xxx
-[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103)
+[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_104~1..v1.1_104)
## Screenshot
@@ -255,6 +255,77 @@ proxies:
{%- endfor -%}
description: random color value
+ address:
+ description: IP address, DNS name, server name
+ type: domainname
+ params:
+ allow_ip: true
+ allow_without_dot: true
+ disabled: &needs_address
+ jinja: |
+ {% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
+ disabled
+ {% endif %}
+ description: |
+ if type not in:
+ - HTTP
+ - HTTPS/SSL
+ - SOCKS4
+ - SOCKS5
+ default:
+ jinja: |
+ {% if firefox.manual.http_proxy.address is not propertyerror %}
+ {{ firefox.manual.http_proxy.address }}
+ {% endif %}
+ description: copy HTTP address if proxy is not "Manual"
+
+ port:
+ description: Port
+ type: port
+ default:
+ jinja: |
+ {% if firefox.manual.http_proxy.port is not propertyerror %}
+ {{ firefox.manual.http_proxy.port }}
+ {% endif %}
+ description: copy HTTP port if proxy is not "Manual"
+ disabled: *needs_address
+
+ username:
+ description: Username
+ type: unix_user
+ mandatory:
+ jinja: |
+ {% if _.password is not propertyerror and _.password %}
+ username is mandatory
+ {% endif %}
+ description: if a password is set
+ disabled: *needs_address
+
+ password:
+ description: Password
+ type: secret
+ mandatory: false
+ disabled: *needs_address
+
+ url:
+ description: URL
+ type: web_address
+ disabled:
+ jinja: |
+ {% if _.type not in ['PAC URL', 'WPAD'] %}
+ proxy does not need url
+ {% endif %}
+ description: |
+ if type is not in:
+ - PAC URL
+ - WPAD
+ default:
+ jinja: |
+ {% if firefox.auto is not propertyerror %}
+ {{ firefox.auto }}
+ {% endif %}
+ description: copy HTTP address if proxy is "Auto"
+
```
### Generated documentation
@@ -329,11 +400,16 @@ This family builds families dynamically.
This family contains lists of variable blocks.
-| Variable | Description |
-|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | 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.
**Default**: random color value. |
+| Variable | Description |
+|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **foxyproxy.proxies.title**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | 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.
**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**:
- 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.
**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.
**Default**: copy HTTP address if proxy is "Auto".
**Disabled**: if type is not in:
- PAC URL
- WPAD. |
## User data
@@ -387,24 +463,8 @@ foxyproxy:
foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u file -ff config/02/config.yaml
```
🛑 ERRORS -┗━━ unknown option "address" in optiondescription "foxyproxy.proxies" (Proxy configuration) -╭────────────────────────── Caption ──────────────────────────╮ -│ Variable Default value │ -│ Undocumented variable Modified value │ -│ Undocumented but modified variable (Original default value) │ -│ Unmodifiable variable │ -╰─────────────────────────────────────────────────────────────╯ -Variables: -┣━━ 📂 firefox -┃ ┣━━ 📓 proxy_mode: No proxy -┃ ┗━━ 📂 dns_over_https -┃ ┗━━ 📓 enable_dns_over_https: False -┗━━ 📂 foxyproxy - ┗━━ 📂 proxies - ┗━━ 📂 title - ┣━━ 📓 title: My company - ┣━━ 📓 type: HTTP (Direct (no proxy)) - ┗━━ 📓 color: #66cc66 +┣━━ The following variables are mandatory but have no value: +┗━━ - foxyproxy.proxies.port (Port)### Example 3 @@ -440,9 +500,12 @@ foxyproxy: foo@bar:~$ rougail -v 1.1 -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -u file -ff config/03/config.yaml ```
🛑 ERRORS -┣━━ unknown option "password" in optiondescription "foxyproxy.proxies" (Proxy configuration) -┣━━ unknown option "username" in optiondescription "foxyproxy.proxies" (Proxy configuration) -┗━━ unknown option "url" in optiondescription "foxyproxy.proxies" (Proxy configuration) +┣━━ cannot access to option "foxyproxy.proxies.password" (Password) because has property "disabled" +┃ (disabled) +┣━━ cannot access to option "foxyproxy.proxies.url" (URL) because has property "disabled" (proxy does not +┃ need url) +┗━━ cannot access to option "foxyproxy.proxies.username" (Username) because has property "disabled" + (disabled) ╭────────────────────────── Caption ──────────────────────────╮ │ Variable Default value │ │ Undocumented variable Modified value │ @@ -474,16 +537,25 @@ Variables: ┣━━ 📂 title ┃ ┣━━ 📓 title: My company ┃ ┣━━ 📓 type: HTTP (Direct (no proxy)) - ┃ ┗━━ 📓 color: #66cc66 + ┃ ┣━━ 📓 color: #66cc66 + ┃ ┣━━ 📓 address: http.proxy.net + ┃ ┣━━ 📓 port: 8080 + ┃ ┣━━ 📓 username: None + ┃ ┗━━ 📓 password: None ┣━━ 📂 title ┃ ┣━━ 📓 title: An other company ┃ ┣━━ 📓 type: SOCKS5 (Direct (no proxy)) - ┃ ┗━━ 📓 color: #cc66cc + ┃ ┣━━ 📓 color: #cc66cc + ┃ ┣━━ 📓 address: http.proxy.net + ┃ ┣━━ 📓 port: 8080 + ┃ ┣━━ 📓 username: my_user + ┃ ┗━━ 📓 password: ********** ┗━━ 📂 title ┣━━ 📓 title: WPAD ┣━━ 📓 type: WPAD (Direct (no proxy)) - ┗━━ 📓 color: #1166cc + ┣━━ 📓 color: #1166cc + ┗━━ 📓 url: http://wpad.proxy.net/wpad.dat-- [[tutorial 104] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_104/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_104~1..v1.1_104)) +- [[tutorial 110] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110)) diff --git a/config/02/output_ro.html b/config/02/output_ro.html index bb68375..1c24b02 100644 --- a/config/02/output_ro.html +++ b/config/02/output_ro.html @@ -1,20 +1,4 @@
🛑 ERRORS -┗━━ unknown option "address" in optiondescription "foxyproxy.proxies" (Proxy configuration) -╭────────────────────────── Caption ──────────────────────────╮ -│ Variable Default value │ -│ Undocumented variable Modified value │ -│ Undocumented but modified variable (Original default value) │ -│ Unmodifiable variable │ -╰─────────────────────────────────────────────────────────────╯ -Variables: -┣━━ 📂 firefox -┃ ┣━━ 📓 proxy_mode: No proxy -┃ ┗━━ 📂 dns_over_https -┃ ┗━━ 📓 enable_dns_over_https: False -┗━━ 📂 foxyproxy - ┗━━ 📂 proxies - ┗━━ 📂 title - ┣━━ 📓 title: My company - ┣━━ 📓 type: HTTP (Direct (no proxy)) - ┗━━ 📓 color: #66cc66 +┣━━ The following variables are mandatory but have no value: +┗━━ - foxyproxy.proxies.port (Port)diff --git a/config/03/output_ro.html b/config/03/output_ro.html index c687f72..adddab8 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,7 +1,10 @@
🛑 ERRORS -┣━━ unknown option "password" in optiondescription "foxyproxy.proxies" (Proxy configuration) -┣━━ unknown option "username" in optiondescription "foxyproxy.proxies" (Proxy configuration) -┗━━ unknown option "url" in optiondescription "foxyproxy.proxies" (Proxy configuration) +┣━━ cannot access to option "foxyproxy.proxies.password" (Password) because has property "disabled" +┃ (disabled) +┣━━ cannot access to option "foxyproxy.proxies.url" (URL) because has property "disabled" (proxy does not +┃ need url) +┗━━ cannot access to option "foxyproxy.proxies.username" (Username) because has property "disabled" + (disabled) ╭────────────────────────── Caption ──────────────────────────╮ │ Variable Default value │ │ Undocumented variable Modified value │ @@ -33,13 +36,22 @@ Variables: ┣━━ 📂 title ┃ ┣━━ 📓 title: My company ┃ ┣━━ 📓 type: HTTP (Direct (no proxy)) - ┃ ┗━━ 📓 color: #66cc66 + ┃ ┣━━ 📓 color: #66cc66 + ┃ ┣━━ 📓 address: http.proxy.net + ┃ ┣━━ 📓 port: 8080 + ┃ ┣━━ 📓 username: None + ┃ ┗━━ 📓 password: None ┣━━ 📂 title ┃ ┣━━ 📓 title: An other company ┃ ┣━━ 📓 type: SOCKS5 (Direct (no proxy)) - ┃ ┗━━ 📓 color: #cc66cc + ┃ ┣━━ 📓 color: #cc66cc + ┃ ┣━━ 📓 address: http.proxy.net + ┃ ┣━━ 📓 port: 8080 + ┃ ┣━━ 📓 username: my_user + ┃ ┗━━ 📓 password: ********** ┗━━ 📂 title ┣━━ 📓 title: WPAD ┣━━ 📓 type: WPAD (Direct (no proxy)) - ┗━━ 📓 color: #1166cc + ┣━━ 📓 color: #1166cc + ┗━━ 📓 url: http://wpad.proxy.net/wpad.dat