tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

Preferences.rst (2700B)

      1 Preferences
      2 ===========
      3 
      4 This document describes preferences affecting Firefox's IP Protection.
      5 These preferences are normally hidden and should not be used unless you really
      6 know what you are doing.
      7 
      8 Feature enablement and experiments
      9 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     10 
     11 ``browser.ipProtection.enabled`` (boolean, default: ``false``)
     12  Master feature toggle controlled by Nimbus and testing harnesses.
     13 
     14 ``browser.ipProtection.userEnabled`` (boolean, default: ``false``)
     15  For testing; simulates user‑enabled state.
     16 
     17 ``browser.ipProtection.variant`` (string, default: ``""``)
     18  Stores the current UI experiment variant. The value is passed to
     19  ``IPProtectionPanel`` to render variant-specific strings and layouts.
     20 
     21 ``browser.ipProtection.added`` (boolean, default: ``false``)
     22  Tracks whether the toolbar button was auto-placed next to the FxA button.
     23  Once true, the widget is not reinserted automatically after manual removal.
     24 
     25 Startup and caching
     26 ~~~~~~~~~~~~~~~~~~~
     27 
     28 ``browser.ipProtection.autoStartEnabled`` (boolean, default: ``false``)
     29  Enables the auto-start helper so the proxy connects during browser startup.
     30 
     31 ``browser.ipProtection.stateCache`` (string, default: ``""``)
     32  Caches the latest ``IPProtectionStates`` value for use during startup.
     33 
     34 ``browser.ipProtection.entitlementCache`` (string, default: ``""``)
     35  Cached entitlement JSON string used during startup to avoid network requests.
     36 
     37 ``browser.ipProtection.locationListCache`` (string, default: ``""``)
     38  Cached Guardian location list shared between ``IPProtectionService`` and
     39  ``GuardianClient``.
     40 
     41 ``browser.ipProtection.cacheDisabled`` (boolean, default: ``false``)
     42  Turns off all startup caches. Used primarily by xpcshell tests.
     43 
     44 Networking and routing
     45 ~~~~~~~~~~~~~~~~~~~~~~
     46 
     47 ``browser.ipProtection.guardian.endpoint`` (string, default: ``"https://vpn.mozilla.org/"``)
     48  Endpoint for the server‑side infrastructure.
     49 
     50 ``browser.ipProtection.productVpn.endpoint`` (string, default: ``"https://www.mozilla.org/"``)
     51  Endpoint for the production mozilla webservice.
     52 
     53 ``browser.ipProtection.mode`` (integer, default: ``0``)
     54  Selects which requests are proxied by ``IPPChannelFilter``:
     55  ``0`` routes all traffic (``MODE_FULL``), ``1`` only private browsing windows
     56  (``MODE_PB``), ``2`` only requests classified as tracking (``MODE_TRACKER``).
     57 
     58 ``browser.ipProtection.override.serverlist`` (string)
     59  A JSON Payload that overrides the server list. Follows the Remote-Settings Schema.
     60 
     61 Diagnostics
     62 ~~~~~~~~~~~
     63 
     64 ``browser.ipProtection.log`` (boolean, default: ``false``)
     65  Enable/disable logging.
     66 
     67 ``browser.ipProtection.panelOpenCount`` (integer, default: ``0``)
     68  Counts the number of times the VPN panel is opened.