Bug 1814798 - pt 1. Add bool to enable/disable PHC at runtime r=glandium
[gecko.git] / remote / doc / Prefs.md
blob68ff234550d55102f05fb1435dc29f522350e78a
1 Preferences
2 ===========
4 There are a couple of preferences associated with the Remote Agent:
7 Configurable preferences
8 ------------------------
10 ### `remote.active-protocols`
12 Defines the remote protocols that are active. Available protocols are,
13 WebDriver BiDi (`1`), and CDP (`2`). Multiple protocols can be activated
14 at the same time by using bitwise or with the values. Defaults to `3` (WebDriver
15 BiDi and CDP).
17 ### `remote.experimental.enabled`
19 Defines if WebDriver BiDi experimental commands and events are available for usage.
20 Defaults to `true` in Nightly builds, and `false` otherwise.
22 ### `remote.log.level`
24 Defines the verbosity of the internal logger.  Available levels
25 are, in descending order of severity, `Trace`, `Debug`, `Config`,
26 `Info`, `Warn`, `Error`, and `Fatal`.  Note that the value is
27 treated case-sensitively.
29 ### `remote.log.truncate`
31 Defines whether long log messages should be truncated. Defaults to true.
33 ### `remote.prefs.recommended`
35 By default remote protocols attempts to set a range of preferences deemed
36 suitable in automation when it starts.  These include the likes of
37 disabling auto-updates, Telemetry, and first-run UX. Set this preference to
38 `false` to skip setting those preferences, which is mostly useful for internal
39 Firefox CI suites.
41 The user preference file takes precedence over the recommended
42 preferences, meaning any user-defined preference value will not be
43 overridden.