rougail-tutorials/firefox/10-manual.yml

---
manual:
  description: Manual proxy configuration
  disabled:
    type: variable
    variable: proxy_mode
    when_not: 'Manual proxy configuration'

  http_proxy:
    description: HTTP Proxy

    address:
      description: HTTP address
      type: domainname
      params:
        allow_ip: true

    port:
      description: HTTP Port
      type: port
      default: 8080
[tutorial 020] A family The "manual" mode structural descriptions are write in a new files to separate things. But Rougail will concatenate variables and families. We create a family, which will contain other variables. This family has: - a description - a type As there is no variable inside this family, the type is mandatory. Without it, Rougail will create a variable. In fact, this family will be deleted by Rougail too because it is empty. 2024-10-23 20:01:17 +02:00			`---`
			`manual:`
			`description: Manual proxy configuration`
[tutorial 028] A conditional disabled family with a variable 2024-10-23 20:01:26 +02:00			`disabled:`
			`type: variable`
			`variable: proxy_mode`
			`when_not: 'Manual proxy configuration'`
[tutorial 021] A sub family Inside a family, we can have variables or families. The "type" for family "manual" became unecessary because container an other family, so it's not a variable. In disabled attribute, it's better tu use relative path (we will see the reason in an other slide). 2024-10-23 20:01:18 +02:00
			`http_proxy:`
			`description: HTTP Proxy`
[tutorial 022] A variable inside sub family 2024-10-23 20:01:19 +02:00
			`address:`
			`description: HTTP address`
[tutorial 024] A variable with type "domainname" 2024-10-23 20:01:21 +02:00			`type: domainname`
[tutorial 025] A variable with type's parameters 2024-10-23 20:01:23 +02:00			`params:`
			`allow_ip: true`
[tutorial 026] A variable with type "port" 2024-10-23 20:01:24 +02:00
			`port:`
			`description: HTTP Port`
			`type: port`
			`default: 8080`