diff --git a/README.md b/README.md index e80294d5..0a51b4a7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial v1.1_040] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040)) +- [[tutorial v1.1_041] A conditional disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)) -# [tutorial v1.1_041] A conditional disabled family +# [tutorial v1.1_042] Copy HTTP manual proxy to HTTPS manual proxy -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042) -[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-disabled-family) +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#copy-http-manual-proxy-to-https-manual-proxy) ## Screenshot @@ -31,7 +31,7 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_041 +git switch --detach v1.1_042 ``` ## Structure @@ -39,14 +39,14 @@ git switch --detach v1.1_041

-.
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     └── 20-manual.yml
+.
+ └── firefox
+     ├── 00-proxy.yml
+     ├── 10-manual.yml
+     └── 20-manual.yml


-Contents of the firefox/10-manual.yml file +Contents of the firefox/20-manual.yml file ```yml %YAML 1.2 @@ -54,21 +54,19 @@ Contents of the firefox/10-manual.yml file version: 1.1 manual: - description: Manual proxy configuration - disabled: - variable: _.proxy_mode - when_not: Manual proxy configuration - http_proxy: # HTTP Proxy + use_for_https: true # Also use this proxy for HTTPS + + https_proxy: # HTTPS Proxy address: - description: HTTP address + description: HTTPS address type: domainname params: allow_ip: true port: - description: HTTP Port + description: HTTPS Port type: port default: 8080 ... @@ -106,6 +104,17 @@ rougail -m firefox/ -o doc |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| | **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true | +##### HTTPS Proxy + +> **🛈 Informations** +> +> **Path**: manual.https_proxy + +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP | +| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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**: 8080 | + ### Let's generate the changelog ```shell @@ -113,69 +122,12 @@ rougail -m firefox/ -o doc --doc.contents changelog ``` #### New variables -| Variable | Description | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.
**Validators**:
• type domainname
• the domain name can be an IP | -| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP 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**: 8080 | -| **manual.use_for_https**
[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.
**Default**: true | +| Variable | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.https_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.
**Validators**:
• type domainname
• the domain name can be an IP | +| **manual.https_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS 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**: 8080 | -## User datas - -### Example 1 - -#### config/01/config.yml -```yml ---- -``` -#### Output - -```shell -rougail -m firefox/ -u yaml -yf config/01/config.yml -``` -
╭──────────────────── Caption ─────────────────────╮
-│ Undocumented but modified variable Default value │
-╰──────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
-### Example 2 - -#### config/02/config.yml - - -```yml ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: 3128 - use_for_https: false -``` -#### Output - -```shell -rougail -m firefox/ -u yaml -yf config/02/config.yml -``` -
╭─────────────────────────── Caption ────────────────────────────╮
-│ Variable                           Modified value              │
-│ Undocumented but modified variable (⏳ Original default value) │
-╰────────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
-┃   loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
-┗━━ 📂 Manual proxy configuration
-    ┣━━ 📂 HTTP Proxy
-    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file 
-    ┃   ┃   "config/02/config.yml"
-    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
-    ┃       "config/02/config.yml" (⏳ 8080)
-    ┗━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file 
-        "config/02/config.yml" (⏳ true)
-
- - -- [[tutorial v1.1_042] Copy HTTP manual proxy to HTTPS manual proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_042/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042)) +- [[tutorial v1.1_043] A conditional hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_043/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_043~1..v1.1_043)) diff --git a/config/01/cmd_ro.txt b/config/01/cmd_ro.txt deleted file mode 100644 index d46f9445..00000000 --- a/config/01/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/01/config.yml \ No newline at end of file diff --git a/config/01/config.yml b/config/01/config.yml deleted file mode 100644 index ed97d539..00000000 --- a/config/01/config.yml +++ /dev/null @@ -1 +0,0 @@ ---- diff --git a/config/01/output_ro.html b/config/01/output_ro.html deleted file mode 100644 index 14a4529d..00000000 --- a/config/01/output_ro.html +++ /dev/null @@ -1,6 +0,0 @@ -
╭──────────────────── Caption ─────────────────────╮
-│ Undocumented but modified variable Default value │
-╰──────────────────────────────────────────────────╯
-Variables:
-┗━━ 📓 Configure Proxy Access to the Internet: No proxy
-
diff --git a/config/02/cmd_ro.txt b/config/02/cmd_ro.txt deleted file mode 100644 index 772ebbef..00000000 --- a/config/02/cmd_ro.txt +++ /dev/null @@ -1 +0,0 @@ -rougail -m firefox/ -u yaml -yf config/02/config.yml \ No newline at end of file diff --git a/config/02/config.yml b/config/02/config.yml deleted file mode 100644 index 9b246a4a..00000000 --- a/config/02/config.yml +++ /dev/null @@ -1,7 +0,0 @@ ---- -proxy_mode: Manual proxy configuration -manual: - http_proxy: - address: http.proxy.net - port: 3128 - use_for_https: false diff --git a/config/02/output_ro.html b/config/02/output_ro.html deleted file mode 100644 index d269aa13..00000000 --- a/config/02/output_ro.html +++ /dev/null @@ -1,16 +0,0 @@ -
╭─────────────────────────── Caption ────────────────────────────╮
-│ Variable                           Modified value              │
-│ Undocumented but modified variable (⏳ Original default value) │
-╰────────────────────────────────────────────────────────────────╯
-Variables:
-┣━━ 📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ 
-┃   loaded from the YAML file "config/02/config.yml" (⏳ No proxy)
-┗━━ 📂 Manual proxy configuration
-    ┣━━ 📂 HTTP Proxy
-    ┃   ┣━━ 📓 HTTP address: http.proxy.net ◀ loaded from the YAML file 
-    ┃   ┃   "config/02/config.yml"
-    ┃   ┗━━ 📓 HTTP Port: 3128 ◀ loaded from the YAML file 
-    ┃       "config/02/config.yml" (⏳ 8080)
-    ┗━━ 📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file 
-        "config/02/config.yml" (⏳ true)
-
diff --git a/tree.html b/tree.html index 1debbe68..dc0c44ee 100644 --- a/tree.html +++ b/tree.html @@ -25,11 +25,11 @@

Directory Tree

- .
- └── firefox
-     ├── 00-proxy.yml
-     ├── 10-manual.yml
-     └── 20-manual.yml
+ .
+ └── firefox
+     ├── 00-proxy.yml
+     ├── 10-manual.yml
+     └── 20-manual.yml


2 directories, 3 files