diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md new file mode 100644 index 00000000..be9dc978 --- /dev/null +++ b/DOCUMENTATION.md @@ -0,0 +1,35 @@ +| Variable | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **proxy_mode**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
• No proxy **← (default)**
• Auto-detect proxy settings for this network
• Use system proxy settings
• Manual proxy configuration
• Automatic proxy configuration URL | + +# Manual proxy configuration + +> [!NOTE] +> +> **Path**: manual + +## HTTP Proxy + +> [!NOTE] +> +> **Path**: manual.http_proxy + +| 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 | + +| Variable | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| **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 + +> [!NOTE] +> +> **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 | diff --git a/README.md b/README.md index 4e417a2c..b85cb285 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_032] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033)) +- [[tutorial v1.1_033] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040)) -# [tutorial v1.1_033] A variable with type "boolean" +# [tutorial v1.1_040] HTTPS family -[Read the tutorial "A variable with type "boolean"" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/types.html#a-variable-with-type-boolean) +[Read the tutorial "HTTPS family" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/properties.html#https-family) ## Screenshot @@ -25,17 +25,17 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach v1.1_033 +git switch --detach v1.1_040 ``` ## Structure

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


Contents of the firefox/20-manual.yml file @@ -48,83 +48,33 @@ version: 1.1 manual: use_for_https: true # Also use this proxy for HTTPS + + https_proxy: # HTTPS Proxy + + address: + description: HTTPS address + type: domainname + params: + allow_ip: true + + port: + description: HTTPS Port + type: port + default: 8080 ... ``` *** -## User datas - -### Example 1 - -#### config/01/config.yml - - -```yml ---- -manual: - http_proxy: - address: example.net -``` - -*** -#### Output +### Let's generate the documentation ```shell -rougail -m firefox/ -u yaml -yf config/01/config.yml +rougail -m firefox/ -o doc ``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value -> - Modified value +[View the documentation file](DOCUMENTATION.md) -Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy -- :open_file_folder: manual (Manual proxy configuration) - - :open_file_folder: http_proxy (HTTP Proxy) - - :notebook: address (HTTP address): example.net ← loaded from the YAML file "config/01/config.yml" - - :notebook: port (HTTP Port): 8080 - - :notebook: use_for_https (Also use this proxy for HTTPS): true - -*** -### Example 2 - -#### config/02/config.yml - - -```yml ---- -manual: - http_proxy: - address: example.net - use_for_https: false -``` - -*** -#### Output - -```shell -rougail -m firefox/ -u yaml -yf config/02/config.yml -``` -> [!NOTE] -> -> **Caption:** -> - Variable -> - Default value -> - Modified value -> - (:hourglass_flowing_sand: Original default value) - -Variables: -- :notebook: proxy_mode (Configure Proxy Access to the Internet): No proxy -- :open_file_folder: manual (Manual proxy configuration) - - :open_file_folder: http_proxy (HTTP Proxy) - - :notebook: address (HTTP address): example.net ← loaded from the YAML file "config/02/config.yml" - - :notebook: port (HTTP Port): 8080 - - :notebook: use_for_https (Also use this proxy for HTTPS): false ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: true) *** -- [[tutorial v1.1_040] HTTPS 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 default value calculated from another variable](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)) 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 22422a2f..00000000 --- a/config/01/config.yml +++ /dev/null @@ -1,4 +0,0 @@ ---- -manual: - http_proxy: - address: example.net diff --git a/config/01/output_ro.html b/config/01/output_ro.html deleted file mode 100644 index c6148c1b..00000000 --- a/config/01/output_ro.html +++ /dev/null @@ -1,13 +0,0 @@ -
╭──────── Caption ────────╮
-│ Variable Default value  │
-│          Modified value │
-╰─────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
-┗━━ 📂 manual (Manual proxy configuration)
-    ┣━━ 📂 http_proxy (HTTP Proxy)
-    ┃   ┣━━ 📓 address (HTTP address): example.net ◀ loaded from the YAML file 
-    ┃   ┃   "config/01/config.yml"
-    ┃   ┗━━ 📓 port (HTTP Port): 8080
-    ┗━━ 📓 use_for_https (Also use this proxy for HTTPS): true
-
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 e4ecc479..00000000 --- a/config/02/config.yml +++ /dev/null @@ -1,5 +0,0 @@ ---- -manual: - http_proxy: - address: example.net - use_for_https: false diff --git a/config/02/output_ro.html b/config/02/output_ro.html deleted file mode 100644 index b0521ddf..00000000 --- a/config/02/output_ro.html +++ /dev/null @@ -1,15 +0,0 @@ -
╭────────────── Caption ───────────────╮
-│ Variable Default value               │
-│          Modified value              │
-│          (⏳ Original default value) │
-╰──────────────────────────────────────╯
-Variables:
-┣━━ 📓 proxy_mode (Configure Proxy Access to the Internet): No proxy
-┗━━ 📂 manual (Manual proxy configuration)
-    ┣━━ 📂 http_proxy (HTTP Proxy)
-    ┃   ┣━━ 📓 address (HTTP address): example.net ◀ loaded from the YAML file 
-    ┃   ┃   "config/02/config.yml"
-    ┃   ┗━━ 📓 port (HTTP Port): 8080
-    ┗━━ 📓 use_for_https (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 dac3ccce..c80855e0 100644 --- a/tree.html +++ b/tree.html @@ -1,7 +1,7 @@

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


\ No newline at end of file