stove/rougail-tutorials

Fork 0

Emmanuel Garette b019f5ee1e [tutorial 082] A web_address variable (config and doc)

2024-11-02 14:58:55 +01:00

44 KiB

Raw Blame History

[tutorial 082] A web_address variable

View the diff

Screenshot

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

firefox/20-manual.yml

---
manual:

  use_for_https: true  # Also use this proxy for HTTPS

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

    address:
      description: "{{ identifier }} address"
      default:
        variable: manual.http_proxy.address

    port:
      description: "{{ identifier }} port"
      default:
        variable: manual.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

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

firefox/40-no_proxy.yml

---
no_proxy:
  description: Address for which proxy will be desactivated
  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
  examples:
    - .mozilla.org
    - .net.nz
    - 192.168.1.0/24
  help: Connections to localhost, 127.0.0.1/8 and ::1 are never proxied

firefox/50-prompt_authentication.yml

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

---
proxy_dns_socks5:
  description: Use proxy DNS when using SOCKS v5
  default: false
  mode: advanced
  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

---
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: dns_over_https.enable_dns_over_https
      when: false

  custom_dns_url:
    description: Custom DNS URL
    type: web_address
    disabled:
      jinja: |
        {% if dns_over_https.provider is propertyerror or dns_over_https.provider != 'Custom' %}
        provider is not custom
        {% endif %}        
      description: if "dns_over_https.provider" is not "Custom"

Generated documentation

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

Variables

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

basic disabled

Disabled: proxy_mode.

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. Default: 8080

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

"HTTPS Proxy" or "SOCKS Proxy"

standard hidden

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

This family builds families dynamically.

Identifiers:
- HTTPS
- SOCKS

Variable	Description
manual.https_proxy.address or manual.socks_proxy.address `domainname` `standard` `mandatory`	"HTTPS address" 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 or manual.socks_proxy.port `port` `standard` `mandatory`	"HTTPS port" or "SOCKS port". Default: the value of the variable "manual.http_proxy.port".
manual.https_proxy.version or 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. Disabled: proxy_mode.
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: proxy_mode.
prompt_authentication `boolean` `standard` `mandatory` `disabled`	Prompt for authentication if password is saved. Default: True Disabled: proxy_mode.

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: dns_over_https.enable_dns_over_https.
dns_over_https.custom_dns_url `web_address` `basic` `mandatory` `disabled`	Custom DNS URL. Disabled: if "dns_over_https.provider" is not "Custom".

User data

Example 1

config/01/config.yaml

---

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ --modes_level basic standard advanced -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
┗━━ 📂 dns_over_https
    ┗━━ 📓 enable_dns_over_https: False

Example 2

config/02/config.yaml

---
dns_over_https:
  enable_dns_over_https: true

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ --modes_level basic standard advanced -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
┗━━ 📂 dns_over_https
    ┣━━ 📓 enable_dns_over_https: True
    ┗━━ 📓 provider: Cloudflare

Example 3

config/03/config.yaml

---
dns_over_https:
  enable_dns_over_https: true
  provider: Custom
  custom_dns_url: http://dns.net

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ --modes_level basic standard advanced -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: No proxy
┗━━ 📂 dns_over_https
    ┣━━ 📓 enable_dns_over_https: True
    ┣━━ 📓 provider: Custom (Cloudflare)
    ┗━━ 📓 custom_dns_url: http://dns.net

Example 4

config/04/config.yaml

---
dns_over_https:
  enable_dns_over_https: true
  provider: Custom
  custom_dns_url: https://dns.net

Output

foo@bar:~$ rougail -v 1.1 -m firefox/ --modes_level basic standard advanced -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: No proxy
┗━━ 📂 dns_over_https
    ┣━━ 📓 enable_dns_over_https: True
    ┣━━ 📓 provider: Custom (Cloudflare)
    ┗━━ 📓 custom_dns_url: https://dns.net

[tutorial 083] A variable with custom validation (diff)

44 KiB Raw Blame History

[tutorial 082] A web_address variable

Screenshot

Structure

firefox/00-proxy.yml

firefox/10-manual.yml

firefox/20-manual.yml

firefox/30-auto.yml

firefox/40-no_proxy.yml

firefox/50-prompt_authentication.yml

firefox/55-proxy_dns_socks5.yml

firefox/60-dns_over_https.yml

Generated documentation

Variables

Manual proxy configuration

HTTP Proxy

"HTTPS Proxy" or "SOCKS Proxy"

DNS over HTTPS

User data

Example 1

config/01/config.yaml

Output

Example 2

config/02/config.yaml

Output

Example 3

config/03/config.yaml

Output

Example 4

config/04/config.yaml

Output

44 KiB

Raw Blame History