|
|
|
|
@ -1,9 +1,9 @@
|
|
|
|
|
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
|
|
|
|
- [[tutorial v1.1_062] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_062~1..v1.1_062))
|
|
|
|
|
- [[tutorial v1.1_063] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_063/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_063~1..v1.1_063))
|
|
|
|
|
|
|
|
|
|
# [tutorial v1.1_063)] Examples
|
|
|
|
|
# [tutorial v1.1_064)] Help
|
|
|
|
|
|
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_063~1..v1.1_063)
|
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_064~1..v1.1_064)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Screenshot
|
|
|
|
|
@ -140,6 +140,7 @@ version: 1.1
|
|
|
|
|
|
|
|
|
|
no_proxy:
|
|
|
|
|
description: Address for which proxy will be desactivated
|
|
|
|
|
help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied
|
|
|
|
|
examples:
|
|
|
|
|
- .mozilla.org
|
|
|
|
|
- .net.nz
|
|
|
|
|
@ -161,7 +162,7 @@ no_proxy:
|
|
|
|
|
### Let's generate the documentation
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_063
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_064
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -o doc -do github
|
|
|
|
|
```
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
@ -212,19 +213,19 @@ 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/>**Validator**: the domain name in web address can be only a hostname<br/>**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL" |
|
|
|
|
|
| **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**: when the variable "proxy_mode" has the value "No proxy" |
|
|
|
|
|
| **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**: when the variable "proxy_mode" has the value "No proxy" |
|
|
|
|
|
|
|
|
|
|
### Let's generate the changelog
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_063
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_064
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
|
|
|
|
|
```
|
|
|
|
|
#### Modified variable
|
|
|
|
|
|
|
|
|
|
| Variable | Description |
|
|
|
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
|
|
|
| **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/>- <ins>.mozilla.org</ins><br/>- <ins>.net.nz</ins><br/>- <ins>192.168.1.0/24</ins><br/>**Disabled**: when the variable "proxy_mode" has the value "No proxy" |
|
|
|
|
|
| **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/><ins>Connections to localhost, 127.0.0.1/8 and ::1 are never proxied.</ins><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**: when the variable "proxy_mode" has the value "No proxy" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## User datas
|
|
|
|
|
@ -241,7 +242,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_063
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_064
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭─────── Caption ────────╮
|
|
|
|
|
@ -257,13 +258,14 @@ Variables:
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: No proxy
|
|
|
|
|
proxy_mode: Automatic proxy configuration URL
|
|
|
|
|
auto: https://auto.proxy.net/wpad.dat
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_063
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_064
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre>╭────────────── Caption ───────────────╮
|
|
|
|
|
@ -271,7 +273,9 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/02/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/02/config.yaml"
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 Address for which proxy will be desactivated:
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 3
|
|
|
|
|
|
|
|
|
|
@ -280,73 +284,30 @@ 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
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_063
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_064
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
|
|
|
|
|
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>SOCKS Proxy
|
|
|
|
|
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>SOCKS address
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 4
|
|
|
|
|
|
|
|
|
|
#### config/04/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: foo
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_063
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
|
|
|
|
<span style="color: #ffff00">┗━━ </span>the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
|
|
|
|
|
<span style="color: #ffff00"> </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/04/config.yaml"
|
|
|
|
|
╭─────── Caption ────────╮
|
|
|
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
|
|
|
╰────────────────────────╯
|
|
|
|
|
<pre>╭────────────── Caption ───────────────╮
|
|
|
|
|
│ Variable Modified value │
|
|
|
|
|
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
|
|
|
|
|
╰──────────────────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
|
|
|
|
</pre>
|
|
|
|
|
### Example 5
|
|
|
|
|
|
|
|
|
|
#### config/05/config.yaml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
---
|
|
|
|
|
proxy_mode: 1
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
#### Output
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
foo@bar:~$ git switch --detach v1.1_063
|
|
|
|
|
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
|
|
|
|
|
```
|
|
|
|
|
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
|
|
|
|
|
<span style="color: #ffff00">┗━━ </span>the value "1" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
|
|
|
|
|
<span style="color: #ffff00"> </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/05/config.yaml"
|
|
|
|
|
╭─────── Caption ────────╮
|
|
|
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
|
|
|
╰────────────────────────╯
|
|
|
|
|
Variables:
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Automatic proxy configuration URL ◀ loaded from the YAML file "config/03/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
|
|
|
|
|
<span style="color: #5c5cff">┣━━ </span>📓 Automatic proxy configuration URL: https://auto.proxy.net/wpad.dat ◀ loaded from the YAML file "config/03/config.yaml"
|
|
|
|
|
<span style="color: #5c5cff">┗━━ </span>📓 Address for which proxy will be desactivated:
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>.example.net ◀ loaded from the YAML file "config/03/config.yaml"
|
|
|
|
|
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>192.168.1.0/24 ◀ loaded from the YAML file "config/03/config.yaml"
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- [[tutorial v1.1_064] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_064/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_064~1..v1.1_064))
|
|
|
|
|
- [[tutorial v1.1_065] A variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_065/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_065~1..v1.1_065))
|
|
|
|
|
|
