rougail-tutorials/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
[tutorial 001] An empty file 2024-09-07 19:06:26 +02:00			`---`
[tutorial 003] A first variable In the Firefox configuration, it is possible to define several configuration modes, from no proxy at all ("No proxy") to a kind of automatic configuration mode from a file ("Automatic proxy configuration URL"). We’re gonna create a first variable called "proxy_mode": - accepts only a string as value - requires a value (that is, None is not an option) 2024-09-07 19:06:28 +02:00			`proxy_mode:`
[tutorial 004] The variable description We can add a description to this first variable. This information is useful for: - documentation - error message - help user to known which value to set to this variable (for example with [the user data plugin Questionary](https://forge.cloud.silique.fr/gnunux/rougail-user-data-questionary)). 2024-09-07 19:06:29 +02:00			`description: Configure Proxy Access to the Internet`
[tutorial 006] A variable with type choice "Foo" should not be an option to the "proxy_mode" variable. Now the "proxy_mode" type is "choice", that means that there is a list of available values that can be selected. We say that the "proxy_mode" variable is constrained (by choices): this variable accept, in fact, only a list of choices. 2024-09-07 19:06:31 +02:00			`choices:`
			`- No proxy`
			`- Auto-detect proxy settings for this network`
			`- Use system proxy settings`
			`- Manual proxy configuration`
			`- Automatic proxy configuration URL`
[tutorial 005] A default value Now we can define the default value of this variable. If the user doesn't touch this variable's value, the value is "No proxy" As user intervention is no more required, so the variable change it's default mode too (from "basic" to "standard"). 2024-09-07 19:06:30 +02:00			`default: No proxy`