155 lines
5.4 KiB
Markdown
155 lines
5.4 KiB
Markdown
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||
- [[tutorial v1.1_140] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_140/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_141~1..v1.1_141))
|
||
|
||
# [tutorial v1.1_141] A choice variable
|
||
|
||
[Read the tutorial "A choice variable" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/jinja.html#a-choice-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_141
|
||
```
|
||
|
||
## Structure
|
||
|
||
<p>
|
||
<a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_141/./">.</a><br/>
|
||
├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_141/./firefox/">firefox</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_141/./firefox/00-proxy.yml">00-proxy.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_141/./firefox/10-manual.yml">10-manual.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_141/./firefox/20-manual.yml">20-manual.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_141/./firefox/30-auto.yml">30-auto.yml</a><br/>
|
||
│ ├── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_141/./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_141/./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_141/./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_141/./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_141/./types/">types</a><br/>
|
||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_141/./types/proxy/">proxy</a><br/>
|
||
└── <a href="https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_141/./types/proxy/00-type.yml">00-type.yml</a><br/>
|
||
<br/><br/></p>
|
||
|
||
Contents of the firefox/60-dns_over_https.yml file
|
||
|
||
```yml
|
||
%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
|
||
...
|
||
|
||
```
|
||
|
||
***
|
||
### Let's generate the documentation
|
||
|
||
```shell
|
||
rougail -m firefox/ --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/ --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/ --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:
|
||
- :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>
|
||
|
||
***
|
||
### Example 2
|
||
|
||
#### config/02/config.yml
|
||
|
||
|
||
```yml
|
||
---
|
||
dns_over_https:
|
||
enable_dns_over_https: true
|
||
```
|
||
|
||
***
|
||
#### Output
|
||
|
||
```shell
|
||
rougail -m firefox/ --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:
|
||
- :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: #006400">true</span> ← loaded from the YAML file "config/02/config.yml" (:hourglass_flowing_sand: false)
|
||
- :notebook: provider (Use Provider): <span style="color: #B8860B">Cloudflare</span>
|
||
|
||
***
|
||
|
||
|
||
- [[tutorial v1.1_142] A web_address variable ](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_142/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_142~1..v1.1_142))
|