File: Preferences.rst

package info (click to toggle)
firefox 149.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,767,760 kB
  • sloc: cpp: 7,416,064; javascript: 6,752,859; ansic: 3,774,850; python: 1,250,473; xml: 641,578; asm: 439,191; java: 186,617; sh: 56,634; makefile: 18,856; objc: 13,092; perl: 12,763; pascal: 5,960; yacc: 4,583; cs: 3,846; lex: 1,720; ruby: 1,002; php: 436; lisp: 258; awk: 105; sql: 66; sed: 53; csh: 10; exp: 6
file content (73 lines) | stat: -rw-r--r-- 2,838 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
Preferences
===========

This document describes preferences affecting Firefox's IP Protection.
These preferences are normally hidden and should not be used unless you really
know what you are doing.

Feature enablement and experiments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``browser.ipProtection.enabled`` (boolean, default: ``false``)
  Master feature toggle controlled by Nimbus and testing harnesses.

``browser.ipProtection.userEnabled`` (boolean, default: ``false``)
  For testing; simulates user‑enabled state.

``browser.ipProtection.added`` (boolean, default: ``false``)
  Tracks whether the toolbar button was auto-placed next to the FxA button.
  Once true, the widget is not reinserted automatically after manual removal.

Startup and caching
~~~~~~~~~~~~~~~~~~~

``browser.ipProtection.autoStartEnabled`` (boolean, default: ``false``)
  Enables the auto-start helper so the proxy connects during browser startup.

``browser.ipProtection.stateCache`` (string, default: ``""``)
  Caches the latest ``IPProtectionStates`` value for use during startup.

``browser.ipProtection.entitlementCache`` (string, default: ``""``)
  Cached entitlement JSON string used during startup to avoid network requests.

``browser.ipProtection.locationListCache`` (string, default: ``""``)
  Cached Guardian location list shared between ``IPProtectionService`` and
  ``GuardianClient``.

``browser.ipProtection.cacheDisabled`` (boolean, default: ``false``)
  Turns off all startup caches. Used primarily by xpcshell tests.

Networking and routing
~~~~~~~~~~~~~~~~~~~~~~

``browser.ipProtection.guardian.endpoint`` (string, default: ``"https://vpn.mozilla.org/"``)
  Endpoint for the server‑side infrastructure.

``browser.ipProtection.productVpn.endpoint`` (string, default: ``"https://www.mozilla.org/"``)
  Endpoint for the production mozilla webservice.

``browser.ipProtection.mode`` (integer, default: ``0``)
  Selects which requests are proxied by ``IPPChannelFilter``:
  ``0`` routes all traffic (``MODE_FULL``), ``1`` only private browsing windows
  (``MODE_PB``), ``2`` only requests classified as tracking (``MODE_TRACKER``).

``browser.ipProtection.override.serverlist`` (string)
  A JSON Payload that overrides the server list. Follows the Remote-Settings Schema.

UI Features
~~~~~~~~~~~

``browser.ipProtection.bandwidth.enabled`` (boolean, default: ``false``)
  Controls whether bandwidth usage information is displayed in the status panel.

``browser.ipProtection.egressLocationEnabled`` (boolean, default: ``false``)
  Controls whether the VPN egress location is displayed in the status panel.

Diagnostics
~~~~~~~~~~~

``browser.ipProtection.log`` (boolean, default: ``false``)
  Enable/disable logging.

``browser.ipProtection.everOpenedPanel`` (boolean, default: ``false``)
  Tracks if the user has ever opened the VPN panel