rougail-tutorials/firefox/10-manual.yml

%YAML 1.2
---
version: 1.1

manual:  # 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
...
[tutorial 020] Group variables inside 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. 2025-11-04 19:22:07 +01:00			`%YAML 1.2`
			`---`
			`version: 1.1`

[tutorial 021] Group variables inside 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. The description can now be has family comment. In disabled attribute, it's better tu use relative path (we will see the reason in an other slide). 2025-11-04 19:22:08 +01:00			`manual: # Manual proxy configuration`

[tutorial 022] A variable inside sub family 2025-11-04 19:22:09 +01:00			`http_proxy: # HTTP Proxy`

[tutorial 023] A variable with type "domainname" 2025-11-04 19:22:10 +01:00			`address:`
			`description: HTTP address`
			`type: domainname`
[tutorial 024] A variable with type's parameters 2025-11-04 19:22:11 +01:00			`params:`
			`allow_ip: true`
[tutorial 025] A variable with type "port" 2025-11-04 19:22:12 +01:00
			`port:`
			`description: HTTP Port`
			`type: port`
			`default: 8080`
[tutorial 020] Group variables inside 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. 2025-11-04 19:22:07 +01:00			`...`