[tutorial v1.1_123] xxx (config and doc)
This commit is contained in:
parent
383fb85065
commit
2d3cf69b4e
2 changed files with 65 additions and 45 deletions
78
README.md
78
README.md
|
|
@ -1,9 +1,9 @@
|
|||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||
- [[tutorial v1.1_121] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_121/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_121~1..v1.1_121))
|
||||
- [[tutorial v1.1_122] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_122~1..v1.1_122))
|
||||
|
||||
# [tutorial v1.1_122] xxx
|
||||
# [tutorial v1.1_123] xxx
|
||||
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_122~1..v1.1_122)
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_123~1..v1.1_123)
|
||||
|
||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#xxx)
|
||||
|
||||
|
|
@ -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_122
|
||||
git switch --detach v1.1_123
|
||||
```
|
||||
|
||||
## Structure
|
||||
|
|
@ -39,22 +39,22 @@ git switch --detach v1.1_122
|
|||
|
||||
|
||||
<p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./">.</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/">firefox</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br/>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/empty.yml">empty.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./foxyproxy/">foxyproxy</a><br/>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./types/">types</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./types/proxy/">proxy</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./types/proxy/00_type.yml">00_type.yml</a><br/>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./">.</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/">firefox</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br/>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/empty.yml">empty.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./foxyproxy/">foxyproxy</a><br/>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./types/">types</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./types/proxy/">proxy</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./types/proxy/00_type.yml">00_type.yml</a><br/>
|
||||
<br/><br/></p>
|
||||
|
||||
Contents of the foxyproxy/00-foxyproxy.yml file
|
||||
|
|
@ -66,12 +66,25 @@ version: 1.1
|
|||
|
||||
proxies:
|
||||
description: Proxy configuration
|
||||
type: leadership
|
||||
_type: leadership
|
||||
|
||||
title:
|
||||
description: Title or Description
|
||||
mandatory: false
|
||||
|
||||
type:
|
||||
description: Proxy Type
|
||||
choices:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5
|
||||
- PAC URL
|
||||
- WPAD
|
||||
- System (use system settings)
|
||||
- Direct (no proxy)
|
||||
default: Direct (no proxy)
|
||||
|
||||
color:
|
||||
description: Color
|
||||
regexp: ^#(?:[0-9a-f]{3}){1,2}$
|
||||
|
|
@ -190,10 +203,11 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox
|
|||
> **Path**: foxyproxy.proxies\
|
||||
> `basic`
|
||||
|
||||
| Variable | Description |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="foxyproxy.proxies.title" name="foxyproxy.proxies.title">foxyproxy.proxies.title</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. |
|
||||
| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
|
||||
| Variable | Description |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="foxyproxy.proxies.title" name="foxyproxy.proxies.title">foxyproxy.proxies.title</a>**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `standard` `unique` | Title or Description. |
|
||||
| **<a id="foxyproxy.proxies.type" name="foxyproxy.proxies.type">foxyproxy.proxies.type</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.<br/>**Choices**: <br/>• HTTP<br/>• HTTPS/SSL<br/>• SOCKS4<br/>• SOCKS5<br/>• PAC URL<br/>• WPAD<br/>• System (use system settings)<br/>• Direct (no proxy) **← (default)** |
|
||||
| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
|
||||
|
||||
|
||||
***
|
||||
|
|
@ -202,11 +216,17 @@ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/prox
|
|||
```shell
|
||||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc --doc.contents changelog --doc.changelog.previous_json_file previous.yml
|
||||
```
|
||||
#### New variable
|
||||
|
||||
| Variable | Description |
|
||||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="foxyproxy.proxies.type" name="foxyproxy.proxies.type">foxyproxy.proxies.type</a>**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.<br/>**Choices**: <br/>• HTTP<br/>• HTTPS/SSL<br/>• SOCKS4<br/>• SOCKS5<br/>• PAC URL<br/>• WPAD<br/>• System (use system settings)<br/>• Direct (no proxy) **← (default)** |
|
||||
|
||||
#### Modified variable
|
||||
|
||||
| Variable | Description |
|
||||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` <ins>`auto modified`</ins> | Color.<br/>**Validator**: <ins>text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"</ins><br/>**Default**: <ins>random color value</ins> |
|
||||
| Variable | Description |
|
||||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
|
||||
| **<a id="foxyproxy.proxies.color" name="foxyproxy.proxies.color">foxyproxy.proxies.color</a>**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
|
||||
|
||||
|
||||
***
|
||||
|
|
@ -244,4 +264,4 @@ Variables:
|
|||
***
|
||||
|
||||
|
||||
- [[tutorial v1.1_123] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_123~1..v1.1_123))
|
||||
- [[tutorial v1.1_124] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_124/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_124~1..v1.1_124))
|
||||
|
|
|
|||
32
tree.html
32
tree.html
|
|
@ -1,18 +1,18 @@
|
|||
<p>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./">.</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/">firefox</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br/>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./firefox/empty.yml">empty.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./foxyproxy/">foxyproxy</a><br/>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./types/">types</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./types/proxy/">proxy</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_122/./types/proxy/00_type.yml">00_type.yml</a><br/>
|
||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./">.</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/">firefox</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/40-no_proxy.yml">40-no_proxy.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/50-prompt_authentication.yml">50-prompt_authentication.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/55-proxy_dns_socks5.yml">55-proxy_dns_socks5.yml</a><br/>
|
||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/60-dns_over_https.yml">60-dns_over_https.yml</a><br/>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./firefox/empty.yml">empty.yml</a><br/>
|
||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./foxyproxy/">foxyproxy</a><br/>
|
||||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./types/">types</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./types/proxy/">proxy</a><br/>
|
||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_123/./types/proxy/00_type.yml">00_type.yml</a><br/>
|
||||
<br/><br/></p>
|
||||
Loading…
Reference in a new issue