rougail-tutorials/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
[tutorial 010] 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-09-07 19:06:33 +02:00			`---`
			`manual:`
			`description: Manual proxy configuration`
[tutorial 011] Conditional desactived family This family will be desactived if "proxy_mode" is not "manual proxy configuration". Desactived a variable or a family means that this variable will never be accessible. 2024-09-07 19:06:33 +02:00			`disabled:`
[tutorial 016] Family in "shorthand" mode The sub family is now in "shorthand" mode. In this mode we can only define "name" and "description" attributes. Inside the sub family we add two variables (with domainname and port types). 2024-09-07 19:06:38 +02:00			`variable: _.proxy_mode`
[tutorial 011] Conditional desactived family This family will be desactived if "proxy_mode" is not "manual proxy configuration". Desactived a variable or a family means that this variable will never be accessible. 2024-09-07 19:06:33 +02:00			`when_not: 'Manual proxy configuration'`
[tutorial 013] 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-09-07 19:06:35 +02:00
[tutorial 018] Family in "shorthand" mode The sub family is now in "shorthand" mode. In this mode we can only define "name" and "description" attributes. Inside the sub family we add two variables (with domainname and port types). 2024-09-07 19:06:40 +02:00			`http_proxy: # HTTP Proxy`
[tutorial 014] Family in "shorthand" mode The sub family is now in "shorthand" mode. In this mode we can only define "name" and "description" attributes. Inside the sub family we add two variables (with domainname and port types). 2024-09-07 19:06:36 +02:00
			`address:`
			`description: HTTP address`
			`type: domainname`
			`params:`
			`allow_ip: true`
[tutorial 015] Family in "shorthand" mode The sub family is now in "shorthand" mode. In this mode we can only define "name" and "description" attributes. Inside the sub family we add two variables (with domainname and port types). 2024-09-07 19:06:37 +02:00
			`port:`
			`description: HTTP Port`
			`type: port`
			`default: 8080`