No description

Find a file

Emmanuel Garette 08ff6ba117 [tutorial 066] A variable		2024-10-23 20:01:53 +02:00
config	[tutorial 066] A variable (config and doc)	2024-10-23 20:01:53 +02:00
firefox	[tutorial 066] A variable	2024-10-23 20:01:53 +02:00
firefox.png	[tutorial 065] A variable in avanced mode (config and doc)	2024-10-23 20:01:52 +02:00
foxyproxy.png	[init] Discover Rougail	2024-10-23 20:01:08 +02:00
README.md	[tutorial 066] A variable (config and doc)	2024-10-23 20:01:53 +02:00

README.md

[tutorial 066] A 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

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

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

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

"HTTPS Proxy" or "SOCKS Proxy"

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` `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` `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` `mandatory` `disabled`	SOCKS host version used by proxy. Choices: - v4 - v5 ← (default) Disabled: when the identifier is "HTTPS".

Variable	Description
auto `web_address` `mandatory` `disabled`	Automatic proxy configuration URL. Disabled: proxy_mode.
no_proxy `domainname` `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` `mandatory` `disabled`	Prompt for authentication if password is saved. Default: True Disabled: proxy_mode.
proxy_dns_socks5 `boolean` `mandatory`	Use proxy DNS when using SOCKS v5. Default: False

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
┗━━ 📓 proxy_dns_socks5: False

Example 2

config/02/config.yaml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net

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: Manual proxy configuration (No proxy)
┣━━ 📂 manual
┃   ┣━━ 📂 http_proxy
┃   ┃   ┣━━ 📓 address: http.proxy.net
┃   ┃   ┗━━ 📓 port: 8080
┃   ┣━━ 📓 use_for_https: True
┃   ┣━━ 📂 https_proxy
┃   ┃   ┣━━ 📓 address: http.proxy.net
┃   ┃   ┗━━ 📓 port: 8080
┃   ┗━━ 📂 socks_proxy
┃       ┣━━ 📓 address: http.proxy.net
┃       ┣━━ 📓 port: 8080
┃       ┗━━ 📓 version: v5
┣━━ 📓 no_proxy :
┣━━ 📓 prompt_authentication: True
┗━━ 📓 proxy_dns_socks5: False

Example 3

config/03/config.yaml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
proxy_dns_socks5: true

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)
┣━━ 📂 manual
┃   ┣━━ 📂 http_proxy
┃   ┃   ┣━━ 📓 address: http.proxy.net
┃   ┃   ┗━━ 📓 port: 8080
┃   ┣━━ 📓 use_for_https: True
┃   ┣━━ 📂 https_proxy
┃   ┃   ┣━━ 📓 address: http.proxy.net
┃   ┃   ┗━━ 📓 port: 8080
┃   ┗━━ 📂 socks_proxy
┃       ┣━━ 📓 address: http.proxy.net
┃       ┣━━ 📓 port: 8080
┃       ┗━━ 📓 version: v5
┣━━ 📓 no_proxy :
┣━━ 📓 prompt_authentication: True
┗━━ 📓 proxy_dns_socks5: True

Example 4

config/04/config.yaml

---
proxy_mode: Manual proxy configuration
manual:
  http_proxy:
    address: http.proxy.net
  socks_proxy:
    version: v4

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: Manual proxy configuration (No proxy)
┣━━ 📂 manual
┃   ┣━━ 📂 http_proxy
┃   ┃   ┣━━ 📓 address: http.proxy.net
┃   ┃   ┗━━ 📓 port: 8080
┃   ┣━━ 📓 use_for_https: True
┃   ┣━━ 📂 https_proxy
┃   ┃   ┣━━ 📓 address: http.proxy.net
┃   ┃   ┗━━ 📓 port: 8080
┃   ┗━━ 📂 socks_proxy
┃       ┣━━ 📓 address: http.proxy.net
┃       ┣━━ 📓 port: 8080
┃       ┗━━ 📓 version: v4 (v5)
┣━━ 📓 no_proxy :
┣━━ 📓 prompt_authentication: True
┗━━ 📓 proxy_dns_socks5: False

[tutorial 067] Jinja calculation for an hidden variable with a potential inaccessible varible (diff)