diff --git a/CHANGELOG.md b/CHANGELOG.md
index 12645cf5..bf11d5db 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,5 @@
-# Modified variable
+# New variable
-| Variable | Description |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
• type domainname
• the domain name can starts by a dot
• the domain name can be a hostname
• the domain name can be an IP
• the domain name can be network in CIDR format
**Examples**:
• .mozilla.org
• .net.nz
• 192.168.1.0/24
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy". |
+| Variable | Description |
+|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **prompt_authentication**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.
**Default**: true
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy". |
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
index 27d7e731..c75c317f 100644
--- a/DOCUMENTATION.md
+++ b/DOCUMENTATION.md
@@ -50,7 +50,8 @@
| **manual.socks_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | 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
**Disabled**: when the variable "[SOCKS proxy address](#manual.socks_proxy.address)" has the value "null". |
| **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 variable "[SOCKS proxy address](#manual.socks_proxy.address)" has the value "null". |
-| Variable | Description |
-|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **auto**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration 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
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL". |
-| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
• type domainname
• the domain name can starts by a dot
• the domain name can be a hostname
• the domain name can be an IP
• the domain name can be network in CIDR format
**Examples**:
• .mozilla.org
• .net.nz
• 192.168.1.0/24
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy". |
+| Variable | Description |
+|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **auto**
[`web address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration 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
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" hasn't the value "Automatic proxy configuration URL". |
+| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` *`disabled`* `unique` | Address for which proxy will be desactivated.
Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.
**Validators**:
• type domainname
• the domain name can starts by a dot
• the domain name can be a hostname
• the domain name can be an IP
• the domain name can be network in CIDR format
**Examples**:
• .mozilla.org
• .net.nz
• 192.168.1.0/24
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy". |
+| **prompt_authentication**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Prompt for authentication if password is saved.
**Default**: true
**Disabled**: when the variable "[Configure Proxy Access to the Internet](#proxy_mode)" has the value "No proxy". |
diff --git a/README.md b/README.md
index 6d0ae0f9..bc8686c1 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_120] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_120/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_121~1..v1.1_121))
+- [[Previous tutorial v1.1_121] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_121/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_130~1..v1.1_130))
-# [tutorial v1.1_121] Help
+# [tutorial v1.1_130] A conditional disabled boolean variable
-- [Read the tutorial "Help" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#help)
-- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_121~1..v1.1_121)
+- [Read the tutorial "A conditional disabled boolean variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/whatsnext.html#a-conditional-disabled-boolean-variable)
+- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_130~1..v1.1_130)
## Screenshot
@@ -26,46 +26,35 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-
Then switch to the tutorial page:
```shell
-git switch --detach v1.1_121
+git switch --detach v1.1_130
```
## Structure
-.
- ├── firefox
- │ ├── 00-proxy.yml
- │ ├── 10-manual.yml
- │ ├── 20-manual.yml
- │ ├── 30-auto.yml
- │ └── 40-no_proxy.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
+ └── types
+ └── proxy
+ └── 00-type.yml
╭────────────── 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): Automatic proxy -┃ configuration URL ◀ loaded from the YAML file "config/02/config.yml" (⏳ No +┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy +┃ configuration ◀ loaded from the YAML file "config/02/config.yml" (⏳ No ┃ proxy) -┣━━ 📓 auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat -┃ ◀ loaded from the YAML file "config/02/config.yml" -┗━━ 📓 no_proxy (Address for which proxy will be desactivated): [] +┣━━ 📂 manual (Manual proxy configuration) +┃ ┣━━ 📂 http_proxy (HTTP Proxy) +┃ ┃ ┣━━ 📓 address (HTTP proxy address): http.proxy.net ◀ loaded from the +┃ ┃ ┃ YAML file "config/02/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 +┃ ┗━━ 📂 socks_proxy (SOCKS Proxy) +┃ ┗━━ 📓 address (SOCKS proxy address): null +┣━━ 📓 no_proxy (Address for which proxy will be desactivated): [] +┗━━ 📓 prompt_authentication (Prompt for authentication if password is saved): + truediff --git a/config/03/config.yml b/config/03/config.yml index 53198970..d04e72ce 100644 --- a/config/03/config.yml +++ b/config/03/config.yml @@ -1,6 +1,6 @@ --- -proxy_mode: Automatic proxy configuration URL -auto: https://auto.proxy.net/wpad.dat -no_proxy: - - .example.net - - 192.168.1.0/24 +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: http.proxy.net +proxy_dns_socks5: true diff --git a/config/03/output_ro.html b/config/03/output_ro.html index f35b2ad7..de3f1066 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -1,14 +1,29 @@ -╭────────────── Caption ───────────────╮ -│ Variable Modified value │ -│ (⏳ Original default value) │ -╰──────────────────────────────────────╯ +🔔 Warning +┗━━ variable or family "proxy_dns_socks5" does not exist so cannot load + "proxy_dns_socks5", it will be ignored when loading from the YAML file + "config/03/config.yml" + +╭───────────────────── Caption ─────────────────────╮ +│ Variable Default value │ +│ Unmodifiable variable Modified value │ +│ (⏳ Original default value) │ +╰───────────────────────────────────────────────────╯ Variables: -┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Automatic proxy -┃ configuration URL ◀ loaded from the YAML file "config/03/config.yml" (⏳ No +┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): Manual proxy +┃ configuration ◀ loaded from the YAML file "config/03/config.yml" (⏳ No ┃ proxy) -┣━━ 📓 auto (Automatic proxy configuration URL): https://auto.proxy.net/wpad.dat -┃ ◀ loaded from the YAML file "config/03/config.yml" -┗━━ 📓 no_proxy (Address for which proxy will be desactivated): - ┣━━ .example.net ◀ loaded from the YAML file "config/03/config.yml" - ┗━━ 192.168.1.0/24 ◀ loaded from the YAML file "config/03/config.yml" +┣━━ 📂 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): 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): null +┣━━ 📓 no_proxy (Address for which proxy will be desactivated): [] +┗━━ 📓 prompt_authentication (Prompt for authentication if password is saved): + truediff --git a/config/04/cmd_ro.txt b/config/04/cmd_ro.txt new file mode 100644 index 00000000..b29c9f32 --- /dev/null +++ b/config/04/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ --types types/proxy -u yaml -yf config/04/config.yml \ No newline at end of file diff --git a/config/04/config.yml b/config/04/config.yml new file mode 100644 index 00000000..8ceca7bc --- /dev/null +++ b/config/04/config.yml @@ -0,0 +1,7 @@ +--- +proxy_mode: Manual proxy configuration +manual: + http_proxy: + address: http.proxy.net + socks_proxy: + version: v4 diff --git a/config/04/output_ro.html b/config/04/output_ro.html new file mode 100644 index 00000000..61682fce --- /dev/null +++ b/config/04/output_ro.html @@ -0,0 +1,31 @@ +🔔 Warning +┗━━ manual (Manual proxy configuration) + ┗━━ socks_proxy (SOCKS Proxy) + ┗━━ version (SOCKS host version used by proxy): 🔔 variable has property + disabled, it will be ignored when loading from the YAML file + "config/04/config.yml" + +╭───────────────────── 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/04/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/04/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 +┃ ┗━━ 📂 socks_proxy (SOCKS Proxy) +┃ ┗━━ 📓 address (SOCKS proxy address): null +┣━━ 📓 no_proxy (Address for which proxy will be desactivated): [] +┗━━ 📓 prompt_authentication (Prompt for authentication if password is saved): + true +diff --git a/firefox.png b/firefox.png index 16f5931c..34e6c084 100644 Binary files a/firefox.png and b/firefox.png differ diff --git a/tree.html b/tree.html index 5b497e62..20fb91d1 100644 --- a/tree.html +++ b/tree.html @@ -1,12 +1,13 @@-.
\ No newline at end of file
- ├── firefox
- │ ├── 00-proxy.yml
- │ ├── 10-manual.yml
- │ ├── 20-manual.yml
- │ ├── 30-auto.yml
- │ └── 40-no_proxy.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
+ └── types
+ └── proxy
+ └── 00-type.yml