[tutorial 074] Help (config and doc)
This commit is contained in:
parent
4902435943
commit
bfa1cd7003
9 changed files with 44 additions and 99 deletions
84
README.md
84
README.md
|
|
@ -1,9 +1,9 @@
|
|||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||
- [[tutorial 072] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_072/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_072~1..v1.1_072))
|
||||
- [[tutorial 073] Examples](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_073~1..v1.1_073))
|
||||
|
||||
# [tutorial 073] Examples
|
||||
# [tutorial 074] Help
|
||||
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_073~1..v1.1_073)
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_074~1..v1.1_074)
|
||||
|
||||
|
||||
## Screenshot
|
||||
|
|
@ -137,6 +137,7 @@ no_proxy:
|
|||
- .mozilla.org
|
||||
- .net.nz
|
||||
- 192.168.1.0/24
|
||||
help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied
|
||||
|
||||
```
|
||||
### Generated documentation
|
||||
|
|
@ -187,7 +188,7 @@ This family builds families dynamically.
|
|||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **auto**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` _`disabled`_ | Automatic proxy configuration URL.<br/>**Disabled**: proxy_mode. |
|
||||
| **no_proxy**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) _`disabled`_ `unique` `multiple` | Address for which proxy will be desactivated.<br/>**Validators**:<br/>- the domain name can starts by a dot<br/>- the domain name can be a hostname<br/>- the domain name can be an IP<br/>- the domain name can be network in CIDR format<br/>**Examples**: <br/>- .mozilla.org<br/>- .net.nz<br/>- 192.168.1.0/24<br/>**Disabled**: proxy_mode. |
|
||||
| **no_proxy**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) _`disabled`_ `unique` `multiple` | Address for which proxy will be desactivated.<br/>Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.<br/>**Validators**:<br/>- the domain name can starts by a dot<br/>- the domain name can be a hostname<br/>- the domain name can be an IP<br/>- the domain name can be network in CIDR format<br/>**Examples**: <br/>- .mozilla.org<br/>- .net.nz<br/>- 192.168.1.0/24<br/>**Disabled**: proxy_mode. |
|
||||
|
||||
|
||||
## User data
|
||||
|
|
@ -222,7 +223,8 @@ Variables:
|
|||
|
||||
```yml
|
||||
---
|
||||
proxy_mode: No proxy
|
||||
proxy_mode: Automatic proxy configuration URL
|
||||
auto: https://auto.proxy.net/wpad.dat
|
||||
|
||||
```
|
||||
#### Output
|
||||
|
|
@ -237,7 +239,9 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml
|
|||
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
|
||||
╰─────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy (<span style="color: #00aa00">No proxy</span>)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Automatic proxy configuration URL (<span style="color: #00aa00">No proxy</span>)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 auto: https://auto.proxy.net/wpad.dat
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 no_proxy :
|
||||
</pre>
|
||||
### Example 3
|
||||
|
||||
|
|
@ -246,7 +250,11 @@ Variables:
|
|||
|
||||
```yml
|
||||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
proxy_mode: Automatic proxy configuration URL
|
||||
auto: https://auto.proxy.net/wpad.dat
|
||||
no_proxy:
|
||||
- .example.net
|
||||
- 192.168.1.0/24
|
||||
|
||||
```
|
||||
#### Output
|
||||
|
|
@ -254,67 +262,19 @@ proxy_mode: Manual proxy configuration
|
|||
```console
|
||||
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml
|
||||
```
|
||||
<pre>🛑 ERRORS
|
||||
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000">┣━━ </span> - manual.http_proxy.address (HTTP address)
|
||||
<span style="color: #ff0000">┗━━ </span> - manual.socks_proxy.address (SOCKS address)
|
||||
</pre>
|
||||
### Example 4
|
||||
|
||||
#### config/04/config.yaml
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
proxy_mode: foo
|
||||
|
||||
```
|
||||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml
|
||||
```
|
||||
<pre>🛑 ERRORS
|
||||
<span style="color: #ff0000">┗━━ </span>"foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only
|
||||
<span style="color: #ff0000"> </span>"Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
|
||||
<span style="color: #ff0000"> </span>configuration", "No proxy" and "Use system proxy settings" are allowed
|
||||
╭────────────────────────── Caption ──────────────────────────╮
|
||||
<pre>╭────────────────────────── Caption ──────────────────────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
│ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
|
||||
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
|
||||
╰─────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
|
||||
</pre>
|
||||
### Example 5
|
||||
|
||||
#### config/05/config.yaml
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
proxy_mode: 1
|
||||
|
||||
```
|
||||
#### Output
|
||||
|
||||
```console
|
||||
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
|
||||
```
|
||||
<pre>🛑 ERRORS
|
||||
<span style="color: #ff0000">┗━━ </span>"1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
|
||||
<span style="color: #ff0000"> </span>proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration",
|
||||
<span style="color: #ff0000"> </span>"No proxy" and "Use system proxy settings" are allowed
|
||||
╭────────────────────────── Caption ──────────────────────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
│ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
|
||||
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
|
||||
╰─────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Automatic proxy configuration URL (<span style="color: #00aa00">No proxy</span>)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 auto: https://auto.proxy.net/wpad.dat
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 no_proxy :
|
||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>.example.net
|
||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>192.168.1.0/24
|
||||
</pre>
|
||||
|
||||
|
||||
- [[tutorial 074] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_074/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_074~1..v1.1_074))
|
||||
- [[tutorial 075] A variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_075/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_075~1..v1.1_075))
|
||||
|
|
|
|||
|
|
@ -1,2 +1,3 @@
|
|||
---
|
||||
proxy_mode: No proxy
|
||||
proxy_mode: Automatic proxy configuration URL
|
||||
auto: https://auto.proxy.net/wpad.dat
|
||||
|
|
|
|||
|
|
@ -5,5 +5,7 @@
|
|||
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
|
||||
╰─────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy (<span style="color: #00aa00">No proxy</span>)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Automatic proxy configuration URL (<span style="color: #00aa00">No proxy</span>)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 auto: https://auto.proxy.net/wpad.dat
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 no_proxy :
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -1,2 +1,6 @@
|
|||
---
|
||||
proxy_mode: Manual proxy configuration
|
||||
proxy_mode: Automatic proxy configuration URL
|
||||
auto: https://auto.proxy.net/wpad.dat
|
||||
no_proxy:
|
||||
- .example.net
|
||||
- 192.168.1.0/24
|
||||
|
|
|
|||
|
|
@ -1,5 +1,13 @@
|
|||
<pre>🛑 ERRORS
|
||||
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
|
||||
<span style="color: #ff0000">┣━━ </span> - manual.http_proxy.address (HTTP address)
|
||||
<span style="color: #ff0000">┗━━ </span> - manual.socks_proxy.address (SOCKS address)
|
||||
<pre>╭────────────────────────── Caption ──────────────────────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
│ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
|
||||
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
|
||||
╰─────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 proxy_mode: Automatic proxy configuration URL (<span style="color: #00aa00">No proxy</span>)
|
||||
<span style="color: #5c5cff">┣━━ </span>📓 auto: https://auto.proxy.net/wpad.dat
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 no_proxy :
|
||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>.example.net
|
||||
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>192.168.1.0/24
|
||||
</pre>
|
||||
|
|
|
|||
|
|
@ -1,2 +0,0 @@
|
|||
---
|
||||
proxy_mode: foo
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<pre>🛑 ERRORS
|
||||
<span style="color: #ff0000">┗━━ </span>"foo" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only
|
||||
<span style="color: #ff0000"> </span>"Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
|
||||
<span style="color: #ff0000"> </span>configuration", "No proxy" and "Use system proxy settings" are allowed
|
||||
╭────────────────────────── Caption ──────────────────────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
│ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
|
||||
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
|
||||
╰─────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
|
||||
</pre>
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
---
|
||||
proxy_mode: 1
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<pre>🛑 ERRORS
|
||||
<span style="color: #ff0000">┗━━ </span>"1" is an invalid choice for "proxy_mode (Configure Proxy Access to the Internet)", only "Auto-detect
|
||||
<span style="color: #ff0000"> </span>proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy configuration",
|
||||
<span style="color: #ff0000"> </span>"No proxy" and "Use system proxy settings" are allowed
|
||||
╭────────────────────────── Caption ──────────────────────────╮
|
||||
│ Variable <span style="color: #ffd700">Default value</span> │
|
||||
│ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
|
||||
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
|
||||
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
|
||||
╰─────────────────────────────────────────────────────────────╯
|
||||
Variables:
|
||||
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: <span style="color: #ffd700">No proxy</span>
|
||||
</pre>
|
||||
Loading…
Reference in a new issue