diff --git a/README.md b/README.md index ce664ca7..af6dadde 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_061] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061)) +- [[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_062)] A non mandatory variable +# [tutorial v1.1_063)] Examples -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_062~1..v1.1_062) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_063~1..v1.1_063) ## Screenshot @@ -140,6 +140,10 @@ version: 1.1 no_proxy: description: Address for which proxy will be desactivated + examples: + - .mozilla.org + - .net.nz + - 192.168.1.0/24 type: domainname params: allow_ip: true @@ -157,7 +161,7 @@ no_proxy: ### Let's generate the documentation ```console -foo@bar:~$ git switch --detach v1.1_062 +foo@bar:~$ git switch --detach v1.1_063 foo@bar:~$ rougail -m firefox/ -o doc -do github ``` | Variable                                                                                        | Description                                                                                     | @@ -208,19 +212,19 @@ This family builds families dynamically | Variable                                                                                                                 | Description                                                                                                              | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **auto**
[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` *`disabled`* | Automatic proxy configuration URL.
**Validator**: the domain name in web address can be only a hostname
**Disabled**: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL" | -| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
**Validators**:
- 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
**Disabled**: when the variable "proxy_mode" has the value "No proxy" | +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
**Validators**:
- 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 "proxy_mode" has the value "No proxy" | ### Let's generate the changelog ```console -foo@bar:~$ git switch --detach v1.1_062 +foo@bar:~$ git switch --detach v1.1_063 foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github ``` #### Modified variable -| Variable                                                                                                                                 | Description                                                                                                                              | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **no_proxy**
~~`mandatory`~~ [`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
**Validators**:
- 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
**Disabled**: when the variable "proxy_mode" has the value "No proxy" | +| Variable                                                                                                                 | Description                                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **no_proxy**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) *`disabled`* `unique` `multiple` | Address for which proxy will be desactivated.
**Validators**:
- 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 "proxy_mode" has the value "No proxy" | ## User datas @@ -237,7 +241,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github #### Output ```console -foo@bar:~$ git switch --detach v1.1_062 +foo@bar:~$ git switch --detach v1.1_063 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml ```
╭─────── Caption ────────╮
@@ -259,7 +263,7 @@ proxy_mode: No proxy
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_062
+foo@bar:~$ git switch --detach v1.1_063
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
 ```
 
╭────────────── Caption ───────────────╮
@@ -282,7 +286,7 @@ proxy_mode: Manual proxy configuration
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_062
+foo@bar:~$ git switch --detach v1.1_063
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
 ```
 
🛑 ERRORS
@@ -306,7 +310,7 @@ proxy_mode: foo
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_062
+foo@bar:~$ git switch --detach v1.1_063
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
 ```
 
🔔 WARNINGS
@@ -331,7 +335,7 @@ proxy_mode: 1
 #### Output
 
 ```console
-foo@bar:~$ git switch --detach v1.1_062
+foo@bar:~$ git switch --detach v1.1_063
 foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
 ```
 
🔔 WARNINGS
@@ -345,4 +349,4 @@ Variables:
 
-- [[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_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))