Summary
This commit is contained in:
parent
8010dc811d
commit
abaa2b37df
15 changed files with 74 additions and 575 deletions
248
README.md
248
README.md
|
|
@ -1,26 +1,24 @@
|
||||||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
# Description
|
||||||
- [[tutorial v1.1_105] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_105~1..v1.1_105))
|
|
||||||
|
|
||||||
# [tutorial v1.1_110)] xxx
|
This tutorial shows to you an example of Rougail use on how to set a proxy in the Mozilla Firefox browser.
|
||||||
|
|
||||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110)
|
More precisely, this tutorial aims at reproducing this [Mozilla Firefox](https://www.mozilla.org/firefox/new/) settings page:
|
||||||
|
|
||||||
[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx)
|
|
||||||
|
|
||||||
|
And the integration of part of the [Firefox FoxyProxy plugin](https://addons.mozilla.org/firefox/addon/foxyproxy-standard/).
|
||||||
|
|
||||||
## Screenshot
|
The idea is to have a namespace specific to FoxyProxy and to find in it part of the settings that we will have made in the main namespace.
|
||||||
|
|
||||||
|
This is what the page looks like:
|
||||||
|
|
||||||
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
|
||||||
|
|
||||||
|
|
||||||
## Clone and install
|
|
||||||
|
|
||||||
|
|
||||||
|
# Installation
|
||||||
|
|
||||||
To test this tutorial, you need to download this repository and install Rougail:
|
To test this tutorial, you need to download this repository and install Rougail:
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
|
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
|
||||||
cd rougail-tutorials
|
cd rougail-tutorials
|
||||||
python -m venv venv_rougail
|
python -m venv venv_rougail
|
||||||
|
|
@ -28,168 +26,70 @@ python -m venv venv_rougail
|
||||||
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
|
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
Then switch to the tutorial page:
|
# Summary
|
||||||
|
|
||||||
```shell
|
Each step is a separerate commit. You can navigate to history to discover different aspect to the Rougail format.
|
||||||
git switch --detach v1.1_110
|
|
||||||
```
|
|
||||||
|
|
||||||
## Structure
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p>
|
|
||||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./">.</a><br/>
|
|
||||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./firefox/">firefox</a><br/>
|
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./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_110/./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_110/./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_110/./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_110/./firefox/empty.yml">empty.yml</a><br/>
|
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./foxyproxy/">foxyproxy</a><br/>
|
|
||||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./foxyproxy/10-redefine.yml">10-redefine.yml</a><br/>
|
|
||||||
<br/><br/></p>
|
|
||||||
|
|
||||||
Contents of the foxyproxy/10-redefine.yml file
|
|
||||||
|
|
||||||
```yml
|
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
|
|
||||||
proxies:
|
|
||||||
|
|
||||||
username:
|
|
||||||
redefine: true
|
|
||||||
mandatory: false
|
|
||||||
|
|
||||||
password:
|
|
||||||
redefine: true
|
|
||||||
hidden:
|
|
||||||
jinja: |-
|
|
||||||
{% if not _.username %}
|
|
||||||
no username defined
|
|
||||||
{% endif %}
|
|
||||||
description: if username is not defined
|
|
||||||
...
|
|
||||||
|
|
||||||
```
|
|
||||||
### Let's generate the documentation
|
|
||||||
|
|
||||||
```shell
|
|
||||||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc
|
|
||||||
```
|
|
||||||
#### Variables for "Firefox"
|
|
||||||
|
|
||||||
**firefox**
|
|
||||||
|
|
||||||
`basic`
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **firefox.proxy_mode**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>- No proxy **← (default)**<br/>- Auto-detect proxy settings for this network<br/>- Use system proxy settings<br/>- Manual proxy configuration<br/>- Automatic proxy configuration URL |
|
|
||||||
|
|
||||||
##### Manual proxy configuration
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Informations |
|
|
||||||
|:------------|
|
|
||||||
| **firefox.manual**<br>`basic` *`disabled`*<br>**Disabled**: when the variable "firefox.proxy_mode" hasn't the value "Manual proxy configuration" |
|
|
||||||
|
|
||||||
###### HTTP Proxy
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Informations |
|
|
||||||
|:------------|
|
|
||||||
| **firefox.manual.http_proxy**<br>`basic` |
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **firefox.manual.http_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP address.<br/>**Validator**: the domain name can be an IP |
|
|
||||||
| **firefox.manual.http_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTP Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **firefox.manual.use_for_https**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
|
|
||||||
|
|
||||||
###### *HTTPS* Proxy or *SOCKS* Proxy
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Informations |
|
|
||||||
|:------------|
|
|
||||||
| **firefox.manual.*https*_proxy**<br/>**firefox.manual.*socks*_proxy**<br>This family builds families dynamically<br>`standard` *`hidden`*<br>**Hidden**: in HTTPS case if "_.use_for_https" is set to "true"<br>**Identifiers**: <br/>- HTTPS<br/>- SOCKS |
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **firefox.manual.*https*_proxy.address**<br/>**firefox.manual.*socks*_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | *HTTPS* or *SOCKS* address.<br/>**Validator**: the domain name can be an IP<br/>**Default**: the value of the variable "firefox.manual.http_proxy.address" |
|
|
||||||
| **firefox.manual.*https*_proxy.port**<br/>**firefox.manual.*socks*_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | *HTTPS* or *SOCKS* port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: the value of the variable "firefox.manual.http_proxy.port" |
|
|
||||||
| **firefox.manual.*https*_proxy.version**<br/>**firefox.manual.*socks*_proxy.version**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | SOCKS host version used by proxy.<br/>**Choices**: <br/>- v4<br/>- v5 **← (default)**<br/>**Disabled**: when the identifier is "HTTPS" |
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **firefox.auto**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Automatic proxy configuration URL.<br/>**Validator**: the domain name in web address can be only a hostname<br/>**Disabled**: when the variable "firefox.proxy_mode" hasn't the value "Automatic proxy configuration URL" |
|
|
||||||
| **firefox.no_proxy**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`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 "firefox.proxy_mode" has the value "No proxy" |
|
|
||||||
| **firefox.prompt_authentication**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Prompt for authentication if password is saved.<br/>**Default**: true<br/>**Disabled**: when the variable "firefox.proxy_mode" has the value "No proxy" |
|
|
||||||
| **firefox.proxy_dns_socks5**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `advanced` `mandatory` *`disabled`* | Use proxy DNS when using SOCKS v5.<br/>**Default**: false<br/>**Disabled**: if "firefox.proxy_mode" is not "Manual proxy configuration"<br/>or "firefox.manual.socks_proxy.version" is "v4" |
|
|
||||||
|
|
||||||
##### DNS over HTTPS
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Informations |
|
|
||||||
|:------------|
|
|
||||||
| **firefox.dns_over_https**<br>`basic` |
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **firefox.dns_over_https.enable_dns_over_https**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Enable DNS over HTTPS.<br/>**Default**: false |
|
|
||||||
| **firefox.dns_over_https.provider**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Use Provider.<br/>**Choices**: <br/>- Cloudflare **← (default)**<br/>- NextDNS<br/>- Custom<br/>**Disabled**: when the variable "firefox.dns_over_https.enable_dns_over_https" has the value "false" |
|
|
||||||
| **firefox.dns_over_https.custom_dns_url**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` *`disabled`* | Custom DNS URL.<br/>**Validators**: <br/>- the domain name in web address can be only a hostname<br/>- must starts with 'https://' only<br/>**Disabled**: if "_.provider" is not "Custom" |
|
|
||||||
|
|
||||||
#### Variables for "FoxyProxy"
|
|
||||||
|
|
||||||
**foxyproxy**
|
|
||||||
|
|
||||||
`basic`
|
|
||||||
|
|
||||||
##### Proxy configuration
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Informations |
|
|
||||||
|:------------|
|
|
||||||
| **foxyproxy.proxies**<br>This family contains lists of variable blocks<br>`basic` |
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **foxyproxy.proxies.title**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | Title or Description. |
|
|
||||||
| **foxyproxy.proxies.type**<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)** |
|
|
||||||
| **foxyproxy.proxies.color**<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 |
|
|
||||||
| **foxyproxy.proxies.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.<br/>**Validators**: <br/>- the domain name can be a hostname<br/>- the domain name can be an IP<br/>**Default**: copy HTTP address if proxy is not "Manual"<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
|
||||||
| **foxyproxy.proxies.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: copy HTTP port if proxy is not "Manual"<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
|
||||||
| **foxyproxy.proxies.username**<br/>[`unix_user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Username.<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
|
||||||
| **foxyproxy.proxies.password**<br/>[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`hidden`* *`disabled`* | Password.<br/>**Hidden**: if username is not defined<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
|
||||||
| **foxyproxy.proxies.url**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.<br/>**Validator**: the domain name in web address can be only a hostname<br/>**Default**: copy HTTP address if proxy is "Auto"<br/>**Disabled**: if type is not in:<br/>- PAC URL<br/>- WPAD |
|
|
||||||
|
|
||||||
### Let's generate the changelog
|
|
||||||
|
|
||||||
```shell
|
|
||||||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc --doc.contents changelog
|
|
||||||
```
|
|
||||||
#### Modified variables
|
|
||||||
|
|
||||||
| Variable | Description |
|
|
||||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| **foxyproxy.proxies.color**<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 |
|
|
||||||
| **foxyproxy.proxies.username**<br/>~~`mandatory`~~ [`unix_user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Username.<br/>**Mandatory**: ~~if a password is set~~<br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
|
||||||
| **foxyproxy.proxies.password**<br/>[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` <ins>*`hidden`*</ins> *`disabled`* | Password.<br/>**Hidden**: <ins>if username is not defined</ins><br/>**Disabled**: if type not in:<br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5 |
|
|
||||||
|
|
||||||
|
- Getting started
|
||||||
|
- Making a structure file
|
||||||
|
- [[tutorial v1.1_000)] Creating a structure file](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_000/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000))
|
||||||
|
- Let's create our first "variable"
|
||||||
|
- [[tutorial v1.1_001)] Let’s add our first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#let-s-add-our-first-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001))
|
||||||
|
- [[tutorial v1.1_002)] Describe the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#describe-the-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002))
|
||||||
|
- [[tutorial v1.1_003)] Set a default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_003/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#set-a-default-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_003~1..v1.1_003))
|
||||||
|
- [[tutorial v1.1_004)] Limits the possible values for the variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_004/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#limits-the-possible-values-for-the-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_004~1..v1.1_004))
|
||||||
|
- Group variables inside "families"
|
||||||
|
- [[tutorial v1.1_010)] Creating a new family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#creating-a-new-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010))
|
||||||
|
- [[tutorial v1.1_011)] Or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_011/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#or-a-sub-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011))
|
||||||
|
- [[tutorial v1.1_012)] Putting a variable inside of a family or a sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_012/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/proxymode.html#putting-a-variable-inside-of-a-family-or-a-sub-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012))
|
||||||
|
- Constrainte the value of a variable with it's type
|
||||||
|
- [[tutorial v1.1_020)] A variable with type "domainname"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"domainname") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020))
|
||||||
|
- [[tutorial v1.1_021)] A variable with type's parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type's-parameters) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021))
|
||||||
|
- [[tutorial v1.1_022)] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"port") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
|
||||||
|
- [[tutorial v1.1_023)] A variable with type "boolean"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_023/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-variable-with-type-"boolean") - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_023~1..v1.1_023))
|
||||||
|
- Define access to variable or family
|
||||||
|
- Property disabled
|
||||||
|
- [[tutorial v1.1_030)] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-disabled-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030))
|
||||||
|
- [[tutorial v1.1_031)] A conditional disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-disabled-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031))
|
||||||
|
- Property hidden
|
||||||
|
- [[tutorial v1.1_032)] Copy HTTP manual proxy to HTTPS manual proxy](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_032/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#copy-http-manual-proxy-to-https-manual-proxy) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_032~1..v1.1_032))
|
||||||
|
- [[tutorial v1.1_033)] A conditional hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_033/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-conditional-hidden-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_033~1..v1.1_033))
|
||||||
|
- Calculated default value for a variable
|
||||||
|
- [[tutorial v1.1_040)] A calculated default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_040/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/disabled.html#a-calculated-default-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_040~1..v1.1_040))
|
||||||
|
- Dynamic family
|
||||||
|
- [[tutorial v1.1_050)] Family: a dynamic family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html#family:-a-dynamic-family) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_050~1..v1.1_050))
|
||||||
|
- [[tutorial v1.1_051)] A conditional disabled variable with dynamic identifier](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_051/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/dynfam.html#a-conditional-disabled-variable-with-dynamic-identifier) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_051~1..v1.1_051))
|
||||||
|
- Playing with Jinja
|
||||||
|
- [[tutorial v1.1_060)] A conditional hidden family with Jinja](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_060/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-hidden-family-with-jinja) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_060~1..v1.1_060))
|
||||||
|
- [[tutorial v1.1_061)] Jinja with a description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_061/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#jinja-with-a-description) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_061~1..v1.1_061))
|
||||||
|
- [[tutorial v1.1_062)] Jinja with a parameter](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_062/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#jinja-with-a-parameter) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_062~1..v1.1_062))
|
||||||
|
- Various variables
|
||||||
|
- [[tutorial v1.1_070)] A conditional disabled variable with type web_address](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_070/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-web_address) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_070~1..v1.1_070))
|
||||||
|
- [[tutorial v1.1_080)] A conditional disabled variable with type domainname and parameters](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_080/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-variable-with-type-domainname-and-parameters) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_080~1..v1.1_080))
|
||||||
|
- Multiple variable
|
||||||
|
- [[tutorial v1.1_081)] A variable with multiple value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_081/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-multiple-value) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_081~1..v1.1_081))
|
||||||
|
- Mandatory
|
||||||
|
- [[tutorial v1.1_082)] A non mandatory variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_082/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-non-mandatory-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_082~1..v1.1_082))
|
||||||
|
- Extras informations for a variable
|
||||||
|
- [[tutorial v1.1_083)] Examples](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_083/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#examples) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_083~1..v1.1_083))
|
||||||
|
- [[tutorial v1.1_084)] Help](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_084/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#help) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_084~1..v1.1_084))
|
||||||
|
- Various variables
|
||||||
|
- [[tutorial v1.1_085)] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_085/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-conditional-disabled-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_085~1..v1.1_085))
|
||||||
|
- [[tutorial v1.1_086)] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_086/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_086~1..v1.1_086))
|
||||||
|
- [[tutorial v1.1_087)] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_087/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-jinja-conditional-disabled-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_087~1..v1.1_087))
|
||||||
|
- Mode
|
||||||
|
- [[tutorial v1.1_088)] A variable in avanced mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_088/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-in-avanced-mode) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_088~1..v1.1_088))
|
||||||
|
- Various variables
|
||||||
|
- [[tutorial v1.1_090)] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_090/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-boolean-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_090~1..v1.1_090))
|
||||||
|
- [[tutorial v1.1_091)] A choice variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_091/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-choice-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_091~1..v1.1_091))
|
||||||
|
- [[tutorial v1.1_092)] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_092/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-web_address-variable) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_092~1..v1.1_092))
|
||||||
|
- Validators
|
||||||
|
- [[tutorial v1.1_093)] A variable with custom validation](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_093/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#a-variable-with-custom-validation) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_093~1..v1.1_093))
|
||||||
|
- Namespace
|
||||||
|
- [[tutorial v1.1_100)] Namespace](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_100/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#namespace) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_100~1..v1.1_100))
|
||||||
|
- [[tutorial v1.1_101)] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_101/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_101~1..v1.1_101))
|
||||||
|
- [[tutorial v1.1_103)] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103))
|
||||||
|
- [[tutorial v1.1_104)] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_104/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_104~1..v1.1_104))
|
||||||
|
- [[tutorial v1.1_105)] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_105~1..v1.1_105))
|
||||||
|
- [[tutorial v1.1_110)] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([doc](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/calculation.html#xxx) - [diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110))
|
||||||
|
|
||||||
|
|
|
||||||
BIN
firefox.png
BIN
firefox.png
Binary file not shown.
|
Before Width: | Height: | Size: 118 KiB After Width: | Height: | Size: 123 KiB |
|
|
@ -1,14 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
|
|
||||||
proxy_mode:
|
|
||||||
description: Configure Proxy Access to the Internet
|
|
||||||
choices:
|
|
||||||
- No proxy
|
|
||||||
- Auto-detect proxy settings for this network
|
|
||||||
- Use system proxy settings
|
|
||||||
- Manual proxy configuration
|
|
||||||
- Automatic proxy configuration URL
|
|
||||||
default: No proxy
|
|
||||||
...
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
|
|
||||||
manual:
|
|
||||||
description: Manual proxy configuration
|
|
||||||
disabled:
|
|
||||||
variable: _.proxy_mode
|
|
||||||
when_not: Manual proxy configuration
|
|
||||||
|
|
||||||
http_proxy: # HTTP Proxy
|
|
||||||
|
|
||||||
address:
|
|
||||||
description: HTTP address
|
|
||||||
type: domainname
|
|
||||||
params:
|
|
||||||
allow_ip: true
|
|
||||||
|
|
||||||
port:
|
|
||||||
description: HTTP Port
|
|
||||||
type: port
|
|
||||||
default: 8080
|
|
||||||
...
|
|
||||||
|
|
@ -1,43 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
|
|
||||||
manual:
|
|
||||||
|
|
||||||
use_for_https: true # Also use this proxy for HTTPS
|
|
||||||
|
|
||||||
'{{ identifier }}_proxy':
|
|
||||||
description: '{{ identifier }} Proxy'
|
|
||||||
hidden:
|
|
||||||
jinja: |-
|
|
||||||
{% if my_identifier == 'HTTPS' and _.use_for_https %}
|
|
||||||
HTTPS is same has HTTP
|
|
||||||
{% endif %}
|
|
||||||
description: in HTTPS case if "_.use_for_https" is set to "true"
|
|
||||||
params:
|
|
||||||
my_identifier:
|
|
||||||
type: identifier
|
|
||||||
dynamic:
|
|
||||||
- HTTPS
|
|
||||||
- SOCKS
|
|
||||||
|
|
||||||
address:
|
|
||||||
description: '{{ identifier }} address'
|
|
||||||
default:
|
|
||||||
variable: __.http_proxy.address
|
|
||||||
|
|
||||||
port:
|
|
||||||
description: '{{ identifier }} port'
|
|
||||||
default:
|
|
||||||
variable: __.http_proxy.port
|
|
||||||
|
|
||||||
version:
|
|
||||||
description: SOCKS host version used by proxy
|
|
||||||
choices:
|
|
||||||
- v4
|
|
||||||
- v5
|
|
||||||
default: v5
|
|
||||||
disabled:
|
|
||||||
type: identifier
|
|
||||||
when: HTTPS
|
|
||||||
...
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
|
|
||||||
auto:
|
|
||||||
description: Automatic proxy configuration URL
|
|
||||||
type: web_address
|
|
||||||
disabled:
|
|
||||||
variable: _.proxy_mode
|
|
||||||
when_not: Automatic proxy configuration URL
|
|
||||||
...
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
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
|
|
||||||
- 192.168.1.0/24
|
|
||||||
type: domainname
|
|
||||||
params:
|
|
||||||
allow_ip: true
|
|
||||||
allow_cidr_network: true
|
|
||||||
allow_without_dot: true
|
|
||||||
allow_startswith_dot: true
|
|
||||||
multi: true
|
|
||||||
mandatory: false
|
|
||||||
disabled:
|
|
||||||
variable: _.proxy_mode
|
|
||||||
when: No proxy
|
|
||||||
...
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
|
|
||||||
prompt_authentication:
|
|
||||||
description: Prompt for authentication if password is saved
|
|
||||||
default: true
|
|
||||||
disabled:
|
|
||||||
variable: _.proxy_mode
|
|
||||||
when: No proxy
|
|
||||||
...
|
|
||||||
|
|
@ -1,19 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
|
|
||||||
proxy_dns_socks5:
|
|
||||||
description: Use proxy DNS when using SOCKS v5
|
|
||||||
mode: advanced
|
|
||||||
default: false
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
|
||||||
{% if _.manual.socks_proxy.version is propertyerror %}
|
|
||||||
the proxy mode is not manual
|
|
||||||
{% elif _.manual.socks_proxy.version == 'v4' %}
|
|
||||||
socks version is v4
|
|
||||||
{% endif %}
|
|
||||||
description: |-
|
|
||||||
if "firefox.proxy_mode" is not "Manual proxy configuration"
|
|
||||||
or "firefox.manual.socks_proxy.version" is "v4"
|
|
||||||
...
|
|
||||||
|
|
@ -1,35 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
|
|
||||||
dns_over_https: # DNS over HTTPS
|
|
||||||
|
|
||||||
enable_dns_over_https: false # Enable DNS over HTTPS
|
|
||||||
|
|
||||||
provider:
|
|
||||||
description: Use Provider
|
|
||||||
choices:
|
|
||||||
- Cloudflare
|
|
||||||
- NextDNS
|
|
||||||
- Custom
|
|
||||||
default: Cloudflare
|
|
||||||
disabled:
|
|
||||||
variable: _.enable_dns_over_https
|
|
||||||
when: false
|
|
||||||
|
|
||||||
custom_dns_url:
|
|
||||||
description: Custom DNS URL
|
|
||||||
type: web_address
|
|
||||||
validators:
|
|
||||||
- jinja: |-
|
|
||||||
{% if _.custom_dns_url.startswith('http://') %}
|
|
||||||
only https is allowed
|
|
||||||
{% endif %}
|
|
||||||
description: must starts with 'https://' only
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
|
||||||
{% if _.provider is propertyerror or _.provider != 'Custom' %}
|
|
||||||
provider is not custom
|
|
||||||
{% endif %}
|
|
||||||
description: if "_.provider" is not "Custom"
|
|
||||||
...
|
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
...
|
|
||||||
|
|
@ -1,139 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
|
|
||||||
proxies:
|
|
||||||
description: Proxy configuration
|
|
||||||
_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}$
|
|
||||||
default:
|
|
||||||
jinja: >-
|
|
||||||
#
|
|
||||||
|
|
||||||
{%- for i in range(6) -%}
|
|
||||||
{{- '0123456789abcdef' | random -}}
|
|
||||||
{%- endfor -%}
|
|
||||||
description: random color value
|
|
||||||
auto_save: true
|
|
||||||
|
|
||||||
address:
|
|
||||||
description: IP address, DNS name, server name
|
|
||||||
type: domainname
|
|
||||||
params:
|
|
||||||
allow_ip: true
|
|
||||||
allow_without_dot: true
|
|
||||||
default:
|
|
||||||
jinja: >-
|
|
||||||
{% if firefox.manual.http_proxy.address is not propertyerror %}
|
|
||||||
{{ firefox.manual.http_proxy.address }}
|
|
||||||
{% endif %}
|
|
||||||
description: copy HTTP address if proxy is not "Manual"
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
|
||||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
|
||||||
disabled
|
|
||||||
{% endif %}
|
|
||||||
description: |-
|
|
||||||
if type not in:
|
|
||||||
- HTTP
|
|
||||||
- HTTPS/SSL
|
|
||||||
- SOCKS4
|
|
||||||
- SOCKS5
|
|
||||||
|
|
||||||
port:
|
|
||||||
description: Port
|
|
||||||
type: port
|
|
||||||
default:
|
|
||||||
jinja: >-
|
|
||||||
{% if firefox.manual.http_proxy.port is not propertyerror %}
|
|
||||||
{{ firefox.manual.http_proxy.port }}
|
|
||||||
{% endif %}
|
|
||||||
description: copy HTTP port if proxy is not "Manual"
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
|
||||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
|
||||||
disabled
|
|
||||||
{% endif %}
|
|
||||||
description: |-
|
|
||||||
if type not in:
|
|
||||||
- HTTP
|
|
||||||
- HTTPS/SSL
|
|
||||||
- SOCKS4
|
|
||||||
- SOCKS5
|
|
||||||
|
|
||||||
username:
|
|
||||||
description: Username
|
|
||||||
type: unix_user
|
|
||||||
mandatory:
|
|
||||||
jinja: |-
|
|
||||||
{% if _.password is not propertyerror and _.password %}
|
|
||||||
username is mandatory
|
|
||||||
{% endif %}
|
|
||||||
description: if a password is set
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
|
||||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
|
||||||
disabled
|
|
||||||
{% endif %}
|
|
||||||
description: |-
|
|
||||||
if type not in:
|
|
||||||
- HTTP
|
|
||||||
- HTTPS/SSL
|
|
||||||
- SOCKS4
|
|
||||||
- SOCKS5
|
|
||||||
|
|
||||||
password:
|
|
||||||
description: Password
|
|
||||||
type: secret
|
|
||||||
mandatory: false
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
|
||||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
|
||||||
disabled
|
|
||||||
{% endif %}
|
|
||||||
description: |-
|
|
||||||
if type not in:
|
|
||||||
- HTTP
|
|
||||||
- HTTPS/SSL
|
|
||||||
- SOCKS4
|
|
||||||
- SOCKS5
|
|
||||||
|
|
||||||
url:
|
|
||||||
description: URL
|
|
||||||
type: web_address
|
|
||||||
default:
|
|
||||||
jinja: >-
|
|
||||||
{% if firefox.auto is not propertyerror %}
|
|
||||||
{{ firefox.auto }}
|
|
||||||
{% endif %}
|
|
||||||
description: copy HTTP address if proxy is "Auto"
|
|
||||||
disabled:
|
|
||||||
jinja: |-
|
|
||||||
{% if _.type not in ['PAC URL', 'WPAD'] %}
|
|
||||||
proxy does not need url
|
|
||||||
{% endif %}
|
|
||||||
description: |-
|
|
||||||
if type is not in:
|
|
||||||
- PAC URL
|
|
||||||
- WPAD
|
|
||||||
...
|
|
||||||
|
|
@ -1,19 +0,0 @@
|
||||||
%YAML 1.2
|
|
||||||
---
|
|
||||||
version: 1.1
|
|
||||||
|
|
||||||
proxies:
|
|
||||||
|
|
||||||
username:
|
|
||||||
redefine: true
|
|
||||||
mandatory: false
|
|
||||||
|
|
||||||
password:
|
|
||||||
redefine: true
|
|
||||||
hidden:
|
|
||||||
jinja: |-
|
|
||||||
{% if not _.username %}
|
|
||||||
no username defined
|
|
||||||
{% endif %}
|
|
||||||
description: if username is not defined
|
|
||||||
...
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
git clone -b 1.1 https://forge.cloud.silique.fr/stove/rougail-tutorials.git
|
|
||||||
cd rougail-tutorials
|
|
||||||
python -m venv venv_rougail
|
|
||||||
. venv_rougail/bin/activate
|
|
||||||
pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user-data-yaml
|
|
||||||
55
tree.html
55
tree.html
|
|
@ -1,55 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
||||||
<meta name="Author" content="Made by 'tree'">
|
|
||||||
<meta name="GENERATOR" content="tree v2.2.1 © 1996 - 2024 by Steve Baker, Thomas Moore, Francesc Rocher, Florian Sesser, Kyosuke Tokoro">
|
|
||||||
<title>Directory Tree</title>
|
|
||||||
<style type="text/css">
|
|
||||||
BODY { font-family : monospace, sans-serif; color: black;}
|
|
||||||
P { font-family : monospace, sans-serif; color: black; margin:0px; padding: 0px;}
|
|
||||||
A:visited { text-decoration : none; margin : 0px; padding : 0px;}
|
|
||||||
A:link { text-decoration : none; margin : 0px; padding : 0px;}
|
|
||||||
A:hover { text-decoration: underline; background-color : yellow; margin : 0px; padding : 0px;}
|
|
||||||
A:active { margin : 0px; padding : 0px;}
|
|
||||||
.VERSION { font-size: small; font-family : arial, sans-serif; }
|
|
||||||
.NORM { color: black; }
|
|
||||||
.FIFO { color: purple; }
|
|
||||||
.CHAR { color: yellow; }
|
|
||||||
.DIR { color: blue; }
|
|
||||||
.BLOCK { color: yellow; }
|
|
||||||
.LINK { color: aqua; }
|
|
||||||
.SOCK { color: fuchsia;}
|
|
||||||
.EXEC { color: green; }
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<h1>Directory Tree</h1><p>
|
|
||||||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./">.</a><br>
|
|
||||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./firefox/">firefox</a><br>
|
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./firefox/00-proxy.yml">00-proxy.yml</a><br>
|
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./firefox/10-manual.yml">10-manual.yml</a><br>
|
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./firefox/20-manual.yml">20-manual.yml</a><br>
|
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./firefox/30-auto.yml">30-auto.yml</a><br>
|
|
||||||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./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_110/./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_110/./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_110/./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_110/./firefox/empty.yml">empty.yml</a><br>
|
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./foxyproxy/">foxyproxy</a><br>
|
|
||||||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br>
|
|
||||||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/./foxyproxy/10-redefine.yml">10-redefine.yml</a><br>
|
|
||||||
<br><br><p>
|
|
||||||
|
|
||||||
3 directories, 11 files
|
|
||||||
|
|
||||||
</p>
|
|
||||||
<hr>
|
|
||||||
<p class="VERSION">
|
|
||||||
tree v2.2.1 © 1996 - 2024 by Steve Baker and Thomas Moore <br>
|
|
||||||
HTML output hacked and copyleft © 1998 by Francesc Rocher <br>
|
|
||||||
JSON output hacked and copyleft © 2014 by Florian Sesser <br>
|
|
||||||
Charsets / OS/2 support © 2001 by Kyosuke Tokoro
|
|
||||||
</p>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
Loading…
Reference in a new issue