stove/rougail-tutorials
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
11 commits 2 branches 50 tags 24 MiB
Find a file
Emmanuel Garette a1969abccd [tutorial 012] A default value 
Now we can define the default value of this variable.

If the user doesn't touch this variable's value, the value is "No proxy"

As user intervention is no more required, so the variable change it's default mode too (from "basic" to "standard").
2024-11-02 14:58:14 +01:00
config [tutorial 012] A default value (config and doc) 2024-11-02 14:58:13 +01:00
firefox [tutorial 012] A default value 2024-11-02 14:58:14 +01:00
firefox.png [tutorial 010] A first variable with only a name (config and doc) 2024-11-02 14:58:12 +01:00
foxyproxy.png [init] Discover Rougail 2024-11-02 14:58:09 +01:00
README.md [tutorial 012] A default value (config and doc) 2024-11-02 14:58:13 +01:00

README.md

[tutorial 012] A default value

View the diff

Screenshot

Firefox Proxy setting

Structure

firefox/00-proxy.yml

---
proxy_mode:
  description: Configure Proxy Access to the Internet
  default: No proxy

Generated documentation

foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github

Variables

Variable                                                                                        Description                                                                                    
proxy_mode
string mandatory		 Configure Proxy Access to the Internet.
Default: No proxy

User data

Example 1

config/01/config.yaml

---

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml

╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: No proxy

Example 2

config/02/config.yaml

---
proxy_mode: No proxy

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml

╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: No proxy (No proxy)

Example 3

config/03/config.yaml

---
proxy_mode: Manual proxy configuration

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml

╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy)

Example 4

config/04/config.yaml

---
proxy_mode: foo

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml

╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: foo (No proxy)

Example 5

config/05/config.yaml

---
proxy_mode: 1

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml

🛑 ERRORS
┗━━ "1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
╭────────────────────────── Caption ──────────────────────────╮
│ Variable                           Default value            │
│ Undocumented variable              Modified value           │
│ Undocumented but modified variable (Original default value) │
│ Unmodifiable variable                                       │
╰─────────────────────────────────────────────────────────────╯
Variables:
┗━━ 📓 proxy_mode: No proxy