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