stove/rougail-tutorials
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
35 commits 2 branches 50 tags 24 MiB
Find a file
Emmanuel Garette 36f2cbd7b5 [tutorial 019] Family in "shorthand" mode 
The sub family is now in "shorthand" mode. In this mode we can only define "name" and "description" attributes.

Inside the sub family we add two variables (with domainname and port types).
2024-10-23 10:58:28 +02:00
firefox [tutorial 019] Family in "shorthand" mode 2024-10-23 10:58:28 +02:00
firefox.png [tutorial 010] A family (config and doc) 2024-10-23 10:58:17 +02:00
foxyproxy.png [init] Discover Rougail 2024-10-23 10:58:06 +02:00
README.md [tutorial 019] Family in "shorthand" mode (config and doc) 2024-10-23 10:58:28 +02:00

README.md

[tutorial 019] Family in "shorthand" mode

View the diff

Screenshot

Firefox Proxy setting

Structure

firefox/00-proxy.yml

---
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

firefox/10-manual.yml

---
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

Generated documentation

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

Variables

Variable                                                                                      Description                                                                                  
proxy_mode
choice mandatory		 Configure Proxy Access to the Internet.
Choices:
- No proxy ← (default)
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL

Manual proxy configuration

disabled

Disabled: when the variable "proxy_mode" hasn't the value "Manual proxy configuration".

HTTP Proxy
Variable                                                                                      Description                                                                                  
manual.http_proxy.address
domainname mandatory		 HTTP address.
Validator: the domain name can be an IP
manual.http_proxy.port
port mandatory		 HTTP Port.
Default: 8080