260 lines
11 KiB
Markdown
260 lines
11 KiB
Markdown
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||
- [[tutorial v1.1_182] Auto save value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_182/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_190~1..v1.1_190))
|
||
|
||
# [tutorial v1.1_190] A variable name that conflict with a known the variable's attribute "type"
|
||
|
||
[Read the tutorial "A variable name that conflict with a known the variable's attribute "type"" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-variable-name-that-conflict-with-a-known-the-variable's-attribute-type)
|
||
|
||
|
||
## Screenshot
|
||
<img src="foxyproxy.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
||
|
||
|
||
## Clone and install
|
||
|
||
To test this tutorial, you need to download this repository and install Rougail:
|
||
|
||
```shell
|
||
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
|
||
```
|
||
|
||
Then switch to the tutorial page:
|
||
|
||
```shell
|
||
git switch --detach v1.1_190
|
||
```
|
||
|
||
## Structure
|
||
|
||
<p>
|
||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./">.</a><br/>
|
||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./firefox/">firefox</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./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_190/./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_190/./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_190/./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_190/./foxyproxy/">foxyproxy</a><br/>
|
||
│ └── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./foxyproxy/00-foxyproxy.yml">00-foxyproxy.yml</a><br/>
|
||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./types/">types</a><br/>
|
||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./types/proxy/">proxy</a><br/>
|
||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_190/./types/proxy/00-type.yml">00-type.yml</a><br/>
|
||
<br/><br/></p>
|
||
|
||
Contents of the foxyproxy/00-foxyproxy.yml file
|
||
|
||
```yml
|
||
%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
|
||
...
|
||
|
||
```
|
||
|
||
***
|
||
### Let's generate the documentation
|
||
|
||
```shell
|
||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -o doc
|
||
```
|
||
[View the documentation file](DOCUMENTATION.md)
|
||
|
||
|
||
***
|
||
### Let's generate the changelog
|
||
|
||
```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
|
||
```
|
||
[View the changelog file](CHANGELOG.md)
|
||
|
||
***
|
||
## User datas
|
||
|
||
### Example 1
|
||
|
||
#### config/01/config.yml
|
||
|
||
|
||
```yml
|
||
---
|
||
```
|
||
|
||
***
|
||
#### Output
|
||
|
||
```shell
|
||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/01/config.yml
|
||
```
|
||
> [!NOTE]
|
||
>
|
||
> **Caption:**
|
||
> - Variable
|
||
> - <span style="color: #B8860B">Default value</span>
|
||
|
||
Variables:
|
||
- :open_file_folder: firefox (Firefox)
|
||
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
|
||
- :open_file_folder: dns_over_https (DNS over HTTPS)
|
||
- :notebook: enable_dns_over_https (Enable DNS over HTTPS): <span style="color: #B8860B">false</span>
|
||
- :open_file_folder: foxyproxy (FoxyProxy)
|
||
- :open_file_folder: proxies (Proxy configuration): <span style="color: #B8860B">[]</span>
|
||
|
||
***
|
||
### Example 2
|
||
|
||
#### config/02/config.yml
|
||
|
||
|
||
```yml
|
||
---
|
||
foxyproxy:
|
||
proxies:
|
||
- title: My company
|
||
type: HTTP
|
||
color: '#66cc66'
|
||
```
|
||
|
||
***
|
||
#### Output
|
||
|
||
```shell
|
||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/02/config.yml
|
||
```
|
||
> [!NOTE]
|
||
>
|
||
> **Caption:**
|
||
> - Variable
|
||
> - <span style="color: #B8860B">Default value</span>
|
||
> - <span style="color: #006400">Modified value</span>
|
||
> - (:hourglass_flowing_sand: Original default value)
|
||
|
||
Variables:
|
||
- :open_file_folder: firefox (Firefox)
|
||
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
|
||
- :open_file_folder: dns_over_https (DNS over HTTPS)
|
||
- :notebook: enable_dns_over_https (Enable DNS over HTTPS): <span style="color: #B8860B">false</span>
|
||
- :open_file_folder: foxyproxy (FoxyProxy)
|
||
- :open_file_folder: proxies (Proxy configuration)
|
||
- :open_file_folder: title (Title or Description)
|
||
- :notebook: title (Title or Description): <span style="color: #006400">My company</span> ← loaded from the YAML file "config/02/config.yml"
|
||
- :notebook: type (Proxy Type): <span style="color: #006400">HTTP</span> ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: Direct (no proxy))
|
||
- :notebook: color (Color): <span style="color: #006400">#66cc66</span> ← loaded from the YAML file "config/02/config.yml"
|
||
|
||
***
|
||
### Example 3
|
||
|
||
#### config/03/config.yml
|
||
|
||
|
||
```yml
|
||
---
|
||
firefox:
|
||
proxy_mode: Manual proxy configuration
|
||
manual:
|
||
http_proxy:
|
||
address: http.proxy.net
|
||
foxyproxy:
|
||
proxies:
|
||
- title: My company
|
||
color: '#66cc66'
|
||
type: HTTP
|
||
- title: An other company
|
||
color: '#cc66cc'
|
||
type: SOCKS5
|
||
- title: WPAD
|
||
color: '#1166cc'
|
||
type: WPAD
|
||
```
|
||
|
||
***
|
||
#### Output
|
||
|
||
```shell
|
||
rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --types types/proxy --modes_level basic standard advanced -u yaml -yf config/03/config.yml
|
||
```
|
||
> [!NOTE]
|
||
>
|
||
> **Caption:**
|
||
> - Variable
|
||
> - <span style="color: #A52A2A">Unmodifiable variable</span>
|
||
> - <span style="color: #B8860B">Default value</span>
|
||
> - <span style="color: #006400">Modified value</span>
|
||
> - (:hourglass_flowing_sand: Original default value)
|
||
|
||
Variables:
|
||
- :open_file_folder: firefox (Firefox)
|
||
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">Manual proxy configuration</span> ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: No proxy)
|
||
- :open_file_folder: manual (Manual proxy configuration)
|
||
- :open_file_folder: http_proxy (HTTP Proxy)
|
||
- :notebook: address (HTTP proxy address): <span style="color: #006400">http.proxy.net</span> ← loaded from the YAML file "config/03/config.yml"
|
||
- :notebook: port (HTTP proxy port): <span style="color: #B8860B">8080</span>
|
||
- :notebook: use_for_https (Also use this proxy for HTTPS): <span style="color: #B8860B">true</span>
|
||
- :open_file_folder: <span style="color: #A52A2A">https_proxy (HTTPS Proxy)</span>
|
||
- :notebook: <span style="color: #A52A2A">address (HTTPS proxy address)</span>: <span style="color: #B8860B">http.proxy.net</span>
|
||
- :notebook: <span style="color: #A52A2A">port (HTTPS proxy port)</span>: <span style="color: #B8860B">8080</span>
|
||
- :open_file_folder: socks_proxy (SOCKS Proxy)
|
||
- :notebook: address (SOCKS proxy address): <span style="color: #B8860B">http.proxy.net</span>
|
||
- :notebook: port (SOCKS proxy port): <span style="color: #B8860B">8080</span>
|
||
- :notebook: version (SOCKS host version used by proxy): <span style="color: #B8860B">v5</span>
|
||
- :notebook: no_proxy (Address for which proxy will be desactivated): <span style="color: #B8860B">[]</span>
|
||
- :notebook: prompt_authentication (Prompt for authentication if password is saved): <span style="color: #B8860B">true</span>
|
||
- :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): <span style="color: #B8860B">false</span>
|
||
- :open_file_folder: dns_over_https (DNS over HTTPS)
|
||
- :notebook: enable_dns_over_https (Enable DNS over HTTPS): <span style="color: #B8860B">false</span>
|
||
- :open_file_folder: foxyproxy (FoxyProxy)
|
||
- :open_file_folder: proxies (Proxy configuration)
|
||
- :open_file_folder: title (Title or Description)
|
||
- :notebook: title (Title or Description): <span style="color: #006400">My company</span> ← loaded from the YAML file "config/03/config.yml"
|
||
- :notebook: type (Proxy Type): <span style="color: #006400">HTTP</span> ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy))
|
||
- :notebook: color (Color): <span style="color: #006400">#66cc66</span> ← loaded from the YAML file "config/03/config.yml"
|
||
- :open_file_folder: title (Title or Description)
|
||
- :notebook: title (Title or Description): <span style="color: #006400">An other company</span> ← loaded from the YAML file "config/03/config.yml"
|
||
- :notebook: type (Proxy Type): <span style="color: #006400">SOCKS5</span> ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy))
|
||
- :notebook: color (Color): <span style="color: #006400">#cc66cc</span> ← loaded from the YAML file "config/03/config.yml"
|
||
- :open_file_folder: title (Title or Description)
|
||
- :notebook: title (Title or Description): <span style="color: #006400">WPAD</span> ← loaded from the YAML file "config/03/config.yml"
|
||
- :notebook: type (Proxy Type): <span style="color: #006400">WPAD</span> ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: Direct (no proxy))
|
||
- :notebook: color (Color): <span style="color: #006400">#1166cc</span> ← loaded from the YAML file "config/03/config.yml"
|
||
|
||
***
|
||
|
||
|
||
- [[tutorial v1.1_200] Variable calculation with propertyerror](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_200/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_200~1..v1.1_200))
|