rougail-tutorials/README.md

• Summary
• [tutorial v1.1_083] A variable with custom validation (diff)

[tutorial v1.1_100)] Namespace

View the diff

Screenshot

Structure

firefox/00-proxy.yml

%YAML 1.2
---
version: 1.1

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

%YAML 1.2
---
version: 1.1

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

firefox/20-manual.yml

%YAML 1.2
---
version: 1.1

manual:

  use_for_https: true  # Also use this proxy for HTTPS

  '{{ identifier }}_proxy':
    description: '{{ identifier }} Proxy'
    hidden:
      jinja: |-
        {% if my_identifier == 'HTTPS' and _.use_for_https %}
          HTTPS is same has HTTP
        {% endif %}        
      description: in HTTPS case if "_.use_for_https" is set to True
      params:
        my_identifier:
          type: identifier
    dynamic:
      - HTTPS
      - SOCKS

    address:
      description: '{{ identifier }} address'
      default:
        variable: __.http_proxy.address

    port:
      description: '{{ identifier }} port'
      default:
        variable: __.http_proxy.port

    version:
      description: SOCKS host version used by proxy
      choices:
        - v4
        - v5
      default: v5
      disabled:
        type: identifier
        when: HTTPS
...

firefox/30-auto.yml

%YAML 1.2
---
version: 1.1

auto:
  description: Automatic proxy configuration URL
  type: web_address
  disabled:
    variable: _.proxy_mode
    when_not: Automatic proxy configuration URL
...

firefox/40-no_proxy.yml

%YAML 1.2
---
version: 1.1

no_proxy:
  description: Address for which proxy will be desactivated
  help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied
  examples:
    - .mozilla.org
    - .net.nz
    - 192.168.1.0/24
  type: domainname
  params:
    allow_ip: true
    allow_cidr_network: true
    allow_without_dot: true
    allow_startswith_dot: true
  multi: true
  mandatory: false
  disabled:
    variable: _.proxy_mode
    when: No proxy
...

firefox/50-prompt_authentication.yml

%YAML 1.2
---
version: 1.1

prompt_authentication:
  description: Prompt for authentication if password is saved
  default: true
  disabled:
    variable: _.proxy_mode
    when: No proxy
...

firefox/55-proxy_dns_socks5.yml

%YAML 1.2
---
version: 1.1

proxy_dns_socks5:
  description: Use proxy DNS when using SOCKS v5
  mode: advanced
  default: false
  disabled:
    jinja: |-
      {% if _.manual.socks_proxy.version is propertyerror %}
        the proxy mode is not manual
      {% elif _.manual.socks_proxy.version == 'v4' %}
        socks version is v4
      {% endif %}      
    description: |-
      if "firefox.proxy_mode" is not "Manual proxy configuration"
      or "firefox.manual.socks_proxy.version" is "v4"      
...

firefox/60-dns_over_https.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

  custom_dns_url:
    description: Custom DNS URL
    type: web_address
    validators:
      - jinja: |-
          {% if dns_over_https.custom_dns_url.startswith('http://') %}
            only https is allowed
          {% endif %}          
        description: must starts with 'https://' only
    disabled:
      jinja: |-
        {% if _.provider is propertyerror or _.provider != 'Custom' %}
          provider is not custom
        {% endif %}        
      description: if "_.provider" is not "Custom"
...

firefox/empty.yml

%YAML 1.2
---
version: 1.1
...

Let's generate the documentation

foo@bar:~$ git switch --detach v1.1_100
foo@bar:~$ rougail -m firefox/ --modes_level basic standard advanced -o doc

Variable	Description
proxy_mode choice standard 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

manual

basic disabled

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

HTTP Proxy

manual.http_proxy

basic

Variable	Description
manual.http_proxy.address domainname basic mandatory	HTTP address. Validator: the domain name can be an IP
manual.http_proxy.port port standard mandatory	HTTP Port. Validators: - well-known ports (1 to 1023) are allowed - registred ports (1024 to 49151) are allowed - private ports (greater than 49152) are allowed Default: 8080

Variable	Description
manual.use_for_https boolean standard mandatory	Also use this proxy for HTTPS. Default: true

HTTPS Proxy or SOCKS Proxy

This family builds families dynamically

manual.https_proxy
manual.socks_proxy

standard hidden

Hidden: in HTTPS case if "_.use_for_https" is set to True

Identifiers:
- HTTPS
- SOCKS

Variable	Description
manual.https_proxy.address manual.socks_proxy.address domainname standard mandatory	HTTPS or SOCKS address. Validator: the domain name can be an IP Default: the value of the variable "manual.http_proxy.address"
manual.https_proxy.port manual.socks_proxy.port port standard mandatory	HTTPS or SOCKS port. Validators: - well-known ports (1 to 1023) are allowed - registred ports (1024 to 49151) are allowed - private ports (greater than 49152) are allowed Default: the value of the variable "manual.http_proxy.port"
manual.https_proxy.version manual.socks_proxy.version choice standard mandatory disabled	SOCKS host version used by proxy. Choices: - v4 - v5 ← (default) Disabled: when the identifier is "HTTPS"

Variable	Description
auto web_address basic mandatory disabled	Automatic proxy configuration URL. Validator: the domain name in web address can be only a hostname Disabled: when the variable "proxy_mode" hasn't the value "Automatic proxy configuration URL"
no_proxy domainname standard disabled unique multiple	Address for which proxy will be desactivated. Connections to localhost, 127.0.0.1/8 and ::1 are never proxied. Validators: - the domain name can starts by a dot - the domain name can be a hostname - the domain name can be an IP - the domain name can be network in CIDR format Examples: - .mozilla.org - .net.nz - 192.168.1.0/24 Disabled: when the variable "proxy_mode" has the value "No proxy"
prompt_authentication boolean standard mandatory disabled	Prompt for authentication if password is saved. Default: true Disabled: when the variable "proxy_mode" has the value "No proxy"
proxy_dns_socks5 boolean advanced mandatory disabled	Use proxy DNS when using SOCKS v5. Default: false Disabled: if "firefox.proxy_mode" is not "Manual proxy configuration"
or "firefox.manual.socks_proxy.version" is "v4"

DNS over HTTPS

dns_over_https

basic

Variable	Description
dns_over_https.enable_dns_over_https boolean standard mandatory	Enable DNS over HTTPS. Default: false
dns_over_https.provider choice standard mandatory disabled	Use Provider. Choices: - Cloudflare ← (default) - NextDNS - Custom Disabled: when the variable "dns_over_https.enable_dns_over_https" has the value "false"
dns_over_https.custom_dns_url web_address basic mandatory disabled	Custom DNS URL. Validators: - the domain name in web address can be only a hostname - must starts with 'https://' only Disabled: if "_.provider" is not "Custom"

• [tutorial v1.1_101] xxx (diff)