252 lines
11 KiB
Markdown
252 lines
11 KiB
Markdown
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||
- [[tutorial v1.1_110] A conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_111~1..v1.1_111))
|
||
|
||
# [tutorial v1.1_111] A boolean variable
|
||
|
||
[Read the tutorial "A boolean variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-boolean-variable)
|
||
|
||
|
||
## Screenshot
|
||
<img src="firefox.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_111
|
||
```
|
||
|
||
## Structure
|
||
|
||
<p>
|
||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/./">.</a><br/>
|
||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/./firefox/">firefox</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/./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_111/./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_111/./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_111/./types/">types</a><br/>
|
||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/./types/proxy/">proxy</a><br/>
|
||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_111/./types/proxy/00-type.yml">00-type.yml</a><br/>
|
||
<br/><br/></p>
|
||
|
||
Contents of the firefox/55-proxy_dns_socks5.yml file
|
||
|
||
```yml
|
||
%YAML 1.2
|
||
---
|
||
version: 1.1
|
||
|
||
proxy_dns_socks5: false # Use proxy DNS when using SOCKS v5
|
||
...
|
||
|
||
```
|
||
|
||
***
|
||
### Let's generate the documentation
|
||
|
||
```shell
|
||
rougail -m firefox/ --types types/proxy -o doc
|
||
```
|
||
[View the documentation file](DOCUMENTATION.md)
|
||
|
||
|
||
***
|
||
### Let's generate the changelog
|
||
|
||
```shell
|
||
rougail -m firefox/ --types types/proxy -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/ --types types/proxy -u yaml -yf config/01/config.yml
|
||
```
|
||
> [!NOTE]
|
||
>
|
||
> **Caption:**
|
||
> - Variable
|
||
> - <span style="color: #B8860B">Default value</span>
|
||
|
||
Variables:
|
||
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #B8860B">No proxy</span>
|
||
- :notebook: proxy_dns_socks5 (Use proxy DNS when using SOCKS v5): <span style="color: #B8860B">false</span>
|
||
|
||
***
|
||
### Example 2
|
||
|
||
#### config/02/config.yml
|
||
|
||
|
||
```yml
|
||
---
|
||
proxy_mode: Manual proxy configuration
|
||
manual:
|
||
http_proxy:
|
||
address: http.proxy.net
|
||
```
|
||
|
||
***
|
||
#### Output
|
||
|
||
```shell
|
||
rougail -m firefox/ --types types/proxy -u yaml -yf config/02/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:
|
||
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">Manual proxy configuration</span> ← loaded from the YAML file "config/02/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/02/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>
|
||
|
||
***
|
||
### Example 3
|
||
|
||
#### config/03/config.yml
|
||
|
||
|
||
```yml
|
||
---
|
||
proxy_mode: Manual proxy configuration
|
||
manual:
|
||
http_proxy:
|
||
address: http.proxy.net
|
||
proxy_dns_socks5: true
|
||
```
|
||
|
||
***
|
||
#### Output
|
||
|
||
```shell
|
||
rougail -m firefox/ --types types/proxy -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:
|
||
- :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: #006400">true</span> ← loaded from the YAML file "config/03/config.yml" (:hourglass_flowing_sand: false)
|
||
|
||
***
|
||
### Example 4
|
||
|
||
#### config/04/config.yml
|
||
|
||
|
||
```yml
|
||
---
|
||
proxy_mode: Manual proxy configuration
|
||
manual:
|
||
http_proxy:
|
||
address: http.proxy.net
|
||
socks_proxy:
|
||
version: v4
|
||
```
|
||
|
||
***
|
||
#### Output
|
||
|
||
```shell
|
||
rougail -m firefox/ --types types/proxy -u yaml -yf config/04/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:
|
||
- :notebook: proxy_mode (Configure Proxy Access to the Internet): <span style="color: #006400">Manual proxy configuration</span> ← loaded from the YAML file "config/04/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/04/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: #006400">v4</span> ← loaded from the YAML file "config/04/config.yml" (:hourglass_flowing_sand: v5)
|
||
- :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>
|
||
|
||
***
|
||
|
||
|
||
- [[tutorial v1.1_112] A Jinja conditional disabled boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_112/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_112~1..v1.1_112))
|