README.md

   1 **These policies are in active development and so might contain changes that do not work with current versions of Firefox.**
   2
   3 **You should use the officially released versions (https://github.com/mozilla/policy-templates/releases) if you are deploying changes.**
   4
   5 Policies can be specified using the Group Policy templates on Windows (https://github.com/mozilla/policy-templates/tree/master/windows), configuration profiles on macOS (https://github.com/mozilla/policy-templates/tree/master/mac), or by creating a file called `policies.json`. On Windows, create a directory called `distribution` where the EXE is located and place the file there. On Mac, the file goes into `Firefox.app/Contents/Resources/distribution`.  On Linux, the file goes into `firefox/distribution`, where `firefox` is the installation directory for firefox, which varies by distribution.
   6
   7 | Policy Name | Description
   8 | --- | --- |
   9 | **[`AppUpdateURL`](#AppUpdateURL)** | Change the URL for application update.
  10 | **[`Authentication`](#Authentication)** | Configure sites that support integrated authentication.
  11 | **[`BlockAboutAddons`](#blockaboutaddons)** | Block access to the Add-ons Manager (about:addons).
  12 | **[`BlockAboutConfig`](#blockaboutconfig)** | Block access to about:config.
  13 | **[`BlockAboutProfiles`](#blockaboutprofiles)** | Block access to About Profiles (about:profiles).
  14 | **[`BlockAboutSupport`](#blockaboutsupport)** | Block access to Troubleshooting Information (about:support).
  15 | **[`Bookmarks`](#bookmarks)** | Add bookmarks in either the bookmarks toolbar or menu.
  16 | **[`CaptivePortal`](#captiveportal)** | Enable or disable the detection of captive portals.
  17 | **[`Certificates`](#certificates)** |
  18 | **[`Certificates -> ImportEnterpriseRoots`](#certificates--importenterpriseroots)** | Trust certificates that have been added to the operating system certificate store by a user or administrator.
  19 | **[`Certificates -> Install`](#certificates--install)** | Install certificates into the Firefox certificate store.
  20 | **[`Cookies`](#cookies)** | Configure cookie preferences.
  21 | **[`DisableSetDesktopBackground`](#disablesetdesktopbackground)** | Remove the "Set As Desktop Background..." menuitem when right clicking on an image.
  22 | **[`DisableMasterPasswordCreation`](#disablemasterpasswordcreation)** | Remove the master password functionality.
  23 | **[`DisableAppUpdate`](#disableappupdate)** | Turn off application updates.
  24 | **[`DisableBuiltinPDFViewer`](#disablebuiltinpdfviewer)** | Disable the built in PDF viewer.
  25 | **[`DisableDeveloperTools`](#disabledevelopertools)** | Remove access to all developer tools.
  26 | **[`DisableFeedbackCommands`](#disablefeedbackcommands)** | Disable the menus for reporting sites.
  27 | **[`DisableFirefoxScreenshots`](#disablefirefoxscreenshots)** | Remove access to Firefox Screenshots.
  28 | **[`DisableFirefoxAccounts`](#disablefirefoxaccounts)** | Disable Firefox Accounts integration (Sync).
  29 | **[`DisableFirefoxStudies`](#disablefirefoxstudies)** | Disable Firefox studies (Shield).
  30 | **[`DisableForgetButton`](#disableforgetbutton)** | Disable the "Forget" button.
  31 | **[`DisableFormHistory`](#disableformhistory)** | Turn off saving information on web forms and the search bar.
  32 | **[`DisablePocket`](#disablepocket)** | Remove Pocket in the Firefox UI.
  33 | **[`DisablePrivateBrowsing`](#disableprivatebrowsing)** | Remove access to private browsing.
  34 | **[`DisableProfileImport`](#disableprofileimport)** | Disables the "Import data from another browser" option in the bookmarks window.
  35 | **[`DisableProfileRefresh`](#disableprofilerefresh)** | Disable the Refresh Firefox button on about:support and support.mozilla.org
  36 | **[`DisableSafeMode`](#disablesafemode)** | Disable safe mode within the browser.
  37 | **[`DisableSecurityBypass`](#disablesecuritybypass)** | Prevent the user from bypassing security in certain cases.
  38 | **[`DisableSystemAddonUpdate`](#disablesystemaddonupdate)** | Prevent system add-ons from being installed or update.
  39 | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry
  40 | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar.
  41 | **[`DisplayMenuBar`](#displaymenubar)** | Set the initial state of the menubar.
  42 | **[`DNSOverHTTPS`](#dnsoverhttps)** | Configure DNS over HTTPS.
  43 | **[`DontCheckDefaultBrowser`](#dontcheckdefaultbrowser)** | Don't check if Firefox is the default browser at startup.
  44 | **[`DefaultDownloadDirectory`](#defaultdownloaddirectory)** | Set the default download directory.
  45 | **[`DownloadDirectory`](#downloaddirectory)** | Set and lock the download directory.
  46 | **[`EnableTrackingProtection`](#enabletrackingprotection)** | Configure tracking protection.
  47 | **[`EnterprisePoliciesEnabled`](#enterprisepoliciesenabled)** | Enable policy support on macOS.
  48 | **[`Extensions`](#extensions)** | Control the installation, uninstallation and locking of extensions.
  49 | **[`ExtensionSettings`](#extensionsettings)** | Manage all aspects of extensions.
  50 | **[`ExtensionUpdate`](#extensionupdate)** | Control extension updates.
  51 | **[`FlashPlugin`](#flashplugin)** | Configure the default Flash plugin policy as well as origins for which Flash is allowed.
  52 | **[`FirefoxHome`](#firefoxhome)** | Customize the Firefox Home page.
  53 | **[`HardwareAcceleration`](#hardwareacceleration)** | Control hardware acceleration.
  54 | **[`Homepage`](#homepage)** | Configure the default homepage and how Firefox starts.
  55 | **[`InstallAddonsPermission`](#installaddonspermission)** | Configure the default extension install policy as well as origins for extension installs are allowed.
  56 | **[`LegacyProfiles`](#legacyprofiles)** | Disable the feature enforcing a separate profile for each installation.
  57 | **[`LocalFileLinks`](#localfilelinks)** | Enable linking to local files by origin.
  58 | **[`NetworkPrediction`](#networkprediction)** | Enable or disable network prediction (DNS prefetching).
  59 | **[`NewTabPage`](#newtabpage)** | Enable or disable the New Tab page.
  60 | **[`NoDefaultBookmarks`](#nodefaultbookmarks)** | Disable the creation of default bookmarks.
  61 | **[`OfferToSaveLogins`](#offertosavelogins)** | Control whether or not Firefox offers to save passwords.
  62 | **[`OfferToSaveLoginsDefault`](#offertosaveloginsdefault)** | Set the default value for whether or not Firefox offers to save passwords.
  63 | **[`OverrideFirstRunPage`](#overridefirstrunpage)** | Override the first run page.
  64 | **[`OverridePostUpdatePage`](#overridepostupdatepage)** | Override the upgrade page.
  65 | **[`PasswordManagerEnabled`](#passwordmanagerenabled)** | Remove (some) access to the password manager.
  66 | **[`Permissions`](#permissions)** | Set permissions associated with camera, microphone, location, and notifications.
  67 | **[`PopupBlocking`](#popupblocking)** | Configure the default pop-up window policy as well as origins for which pop-up windows are allowed.
  68 | **[`Preferences`](#preferences)** | Set and lock some preferences.
  69 | **[`PromptForDownloadLocation`](#promptfordownloadlocation)** | Ask where to save each file before downloading.
  70 | **[`Proxy`](#proxy)** | Configure proxy settings.
  71 | **[`RequestedLocales`](#requestedlocales)** | Set the the list of requested locales for the application in order of preference.
  72 | **[`SanitizeOnShutdown` (All)](#sanitizeonshutdown-all)** | Clear all data on shutdown.
  73 | **[`SanitizeOnShutdown` (Selective)](#sanitizeonshutdown-selective)** | Clear data on shutdown.
  74 | **[`SearchBar`](#searchbar)** | Set whether or not search bar is displayed.
  75 | **[`SearchEngines`](#searchengines-this-policy-is-only-available-on-the-esr)** |
  76 | **[`SearchEngines -> Default`](#searchengines--default)** | Set the default search engine.
  77 | **[`SearchEngines -> PreventInstalls`](#searchengines--preventinstalls)** | Prevent installing search engines from webpages.
  78 | **[`SearchEngines -> Remove`](#searchengines--remove)** | Hide built-in search engines.
  79 | **[`SearchEngines -> Add`](#searchengines--add)** | Add new search engines.
  80 | **[`SecurityDevices`](#securitydevices)** | Install PKCS #11 modules.
  81 | **[`SearchSuggestEnabled`](#searchsuggestenabled)** | Enable search suggestions.
  82 | **[`SSLVersionMax`](#sslversionmax)** | Set and lock the maximum version of TLS.
  83 | **[`SSLVersionMin`](#sslversionmin)** | Set and lock the minimum version of TLS.
  84 | **[`SupportMenu`](#supportmenu)** | Add a menuitem to the help menu for specifying support information.
  85 | **[`WebsiteFilter`](#websitefilter)** | Block websites from being visited.
  86
  87 ### AppUpdateURL
  88
  89 Change the URL for application update.
  90
  91 **Compatibility:** Firefox 62, Firefox ESR 60.2\
  92 **CCK2 Equivalent:** N/A\
  93 **Preferences Affected:** `app.update.url`
  94
  95 #### Windows (GPO)
  96 ```
  97 Software\Policies\Mozilla\Firefox\AppUpdateURL = "https://yoursite.com"
  98 ```
  99 #### macOS
 100 ```
 101 <dict>
 102   <key>AppUpdateURL</key>
 103   <string>https://yoursite.com</string>
 104 </dict>
 105 ```
 106 #### policies.json
 107 ```
 108 {
 109   "policies": {
 110     "AppUpdateURL": "https://yoursite.com"
 111   }
 112 }
 113 ```
 114 ### Authentication
 115
 116 Configure sites that support integrated authentication.
 117
 118 See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
 119
 120 **Compatibility:** Firefox 60, Firefox ESR 60 (AllowNonFQDN added in 62/60.2, AllowProxies added in 70/68.2, Locked added in 71/68.3)\
 121 **CCK2 Equivalent:** N/A\
 122 **Preferences Affected:** `network.negotiate-auth.trusted-uris`,`network.negotiate-auth.delegation-uris`,`network.automatic-ntlm-auth.trusted-uris`,`network.automatic-ntlm-auth.allow-non-fqdn`,`network.negotiate-auth.allow-non-fqdn`,`network.automatic-ntlm-auth.allow-proxies`,`network.negotiate-auth.allow-proxies`
 123
 124 #### Windows (GPO)
 125 ```
 126 Software\Policies\Mozilla\Firefox\Authentication\SPNEGO\1 = "mydomain.com"
 127 Software\Policies\Mozilla\Firefox\Authentication\SPNEGO\2 = "https://myotherdomain.com"
 128 Software\Policies\Mozilla\Firefox\Authentication\Delegated\1 = "mydomain.com"
 129 Software\Policies\Mozilla\Firefox\Authentication\Delegated\2 = "https://myotherdomain.com"
 130 Software\Policies\Mozilla\Firefox\Authentication\NTLM\1 = "mydomain.com"
 131 Software\Policies\Mozilla\Firefox\Authentication\NTLM\2 = "https://myotherdomain.com"
 132 Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\SPNEGO = 0x1 | 0x0
 133 Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\NTLM = 0x1 | 0x0
 134 Software\Policies\Mozilla\Firefox\Authentication\AllowProxies\SPNEGO = 0x1 | 0x0
 135 Software\Policies\Mozilla\Firefox\Authentication\AllowProxies\NTLM = 0x1 | 0x0
 136 Software\Policies\Mozilla\Firefox\Authentication\Locked = 0x1 | 0x0
 137 ```
 138 #### Windows (Intune)
 139 OMA-URI:
 140 ```
 141 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Authentication/Authentication_SPNEGO
 142 ```
 143 Value (string):
 144 ```
 145 <enabled/>
 146
 147 <data id="Authentication" value="1&#xF000;mydomain&#xF000;2&#xF000;https://myotherdomain.com"/>
 148 ```
 149 OMA-URI:
 150 ```
 151 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Authentication/Authentication_Delegated
 152 ```
 153 Value (string):
 154 ```
 155 <enabled/>
 156
 157 <data id="Authentication" value="1&#xF000;mydomain&#xF000;2&#xF000;https://myotherdomain.com"/>
 158 ```
 159 OMA-URI:
 160 ```
 161 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Authentication/Authentication_NTLM
 162 ```
 163 Value (string):
 164 ```
 165 <enabled/>
 166
 167 <data id="Authentication" value="1&#xF000;mydomain&#xF000;2&#xF000;https://myotherdomain.com"/>
 168 ```
 169 ```OMA-URI:
 170 ```
 171 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Authentication/Authentication_AllowNonFQDN
 172 ```
 173 Value (string):
 174 ```
 175 <enabled/>
 176
 177 <data id="Authentication_AllowNonFQDN_NTLM" value="true | false"/>
 178 <data id="Authentication_AllowNonFQDN_SPNEGO" value="true | false"/>
 179 ```
 180 OMA-URI:
 181 ```
 182 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Homepage/HomepageStartPage
 183 ```
 184 Value (string):
 185 ```
 186 <enabled/>
 187
 188 <data id="StartPage" value="none | homepage | previous-session"/>
 189 ```
 190 #### macOS
 191 ```
 192 <dict>
 193   <key>Authentication</key>
 194   <dict>
 195     <key>SPNEGO</key>
 196     <array>
 197       <string>mydomain.com</string>
 198       <string>https://myotherdomain.com</string>
 199     </array>
 200     <key>Delegated</key>
 201     <array>
 202       <string>mydomain.com</string>
 203       <string>https://myotherdomain.com</string>
 204     </array>
 205     <key>NTLM</key>
 206     <array>
 207       <string>mydomain.com</string>
 208       <string>https://myotherdomain.com</string>
 209     </array>
 210     <key>AllowNonFQDN</key>
 211       <dict>
 212       <key>SPNEGO</key>
 213       <true/> | <false/>
 214       <key>NTLM</key>
 215       <true/> | <false/>
 216     </dict>
 217     <key>AllowProxies</key>
 218       <dict>
 219       <key>SPNEGO</key>
 220       <true/> | <false/>
 221       <key>NTLM</key>
 222       <true/> | <false/>
 223     </dict>
 224     <key>Locked</key>
 225     <true/> | <false/>
 226   </dict>
 227 </dict>
 228 ```
 229 #### policies.json
 230 ```
 231 {
 232   "policies": {
 233     "Authentication": {
 234       "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
 235       "Delegated": ["mydomain.com", "https://myotherdomain.com"],
 236       "NTLM": ["mydomain.com", "https://myotherdomain.com"],
 237       "AllowNonFQDN": {
 238         "SPNEGO": true | false,
 239         "NTLM": true | false
 240       },
 241       "AllowProxies": {
 242         "SPNEGO": true | false,
 243         "NTLM": true | false
 244       },
 245       "Locked": true | false
 246     }
 247   }
 248 }
 249 ```
 250 ### BlockAboutAddons
 251
 252 Block access to the Add-ons Manager (about:addons).
 253
 254 **Compatibility:** Firefox 60, Firefox ESR 60\
 255 **CCK2 Equivalent:** `disableAddonsManager`\
 256 **Preferences Affected:** N/A
 257
 258 #### Windows (GPO)
 259 ```
 260 Software\Policies\Mozilla\Firefox\BlockAboutAddons = 0x1 | 0x0
 261 ```
 262 #### Windows (Intune)
 263 OMA-URI:
 264 ```
 265 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/BlockAboutAddons
 266 ```
 267 Value (string):
 268 ```
 269 <enabled/>
 270 ```
 271 #### macOS
 272 ```
 273 <dict>
 274   <key>BlockAboutAddons</key>
 275   <true/> | <false/>
 276 </dict>
 277 ```
 278 #### policies.json
 279 ```
 280 {
 281   "policies": {
 282     "BlockAboutAddons": true | false
 283   }
 284 }
 285 ```
 286 ### BlockAboutConfig
 287
 288 Block access to about:config.
 289
 290 **Compatibility:** Firefox 60, Firefox ESR 60\
 291 **CCK2 Equivalent:** `disableAboutConfig`\
 292 **Preferences Affected:** N/A
 293
 294 #### Windows (GPO)
 295 ```
 296 Software\Policies\Mozilla\Firefox\BlockAboutConfig = 0x1 | 0x0
 297 ```
 298 #### Windows (Intune)
 299 OMA-URI:
 300 ```
 301 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/BlockAboutConfig
 302 ```
 303 Value (string):
 304 ```
 305 <enabled/>
 306 ```
 307 #### macOS
 308 ```
 309 <dict>
 310   <key>BlockAboutConfig</key>
 311   <true/> | <false/>
 312 </dict>
 313 ```
 314 #### policies.json
 315 ```
 316 {
 317   "policies": {
 318     "BlockAboutConfig": true | false
 319   }
 320 }
 321 ```
 322 ### BlockAboutProfiles
 323
 324 Block access to About Profiles (about:profiles).
 325
 326 **Compatibility:** Firefox 60, Firefox ESR 60\
 327 **CCK2 Equivalent:** `disableAboutProfiles`\
 328 **Preferences Affected:** N/A
 329
 330 #### Windows (GPO)
 331 ```
 332 Software\Policies\Mozilla\Firefox\BlockAboutProfiles = 0x1 | 0x0
 333 ```
 334 #### Windows (Intune)
 335 OMA-URI:
 336 ```
 337 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/BlockAboutProfiles
 338 ```
 339 Value (string):
 340 ```
 341 <enabled/>
 342 ```
 343 #### macOS
 344 ```
 345 <dict>
 346   <key>BlockAboutProfiles</key>
 347   <true/> | <false/>
 348 </dict>
 349 ```
 350 #### policies.json
 351 ```
 352 {
 353   "policies": {
 354     "BlockAboutProfiles": true | false
 355   }
 356 }
 357 ```
 358 ### BlockAboutSupport
 359
 360 Block access to Troubleshooting Information (about:support).
 361
 362 **Compatibility:** Firefox 60, Firefox ESR 60\
 363 **CCK2 Equivalent:** `disableAboutSupport`\
 364 **Preferences Affected:** N/A
 365
 366 #### Windows (GPO)
 367 ```
 368 Software\Policies\Mozilla\Firefox\BlockAboutSupport = 0x1 | 0x0
 369 ```
 370 #### Windows (Intune)
 371 OMA-URI:
 372 ```
 373 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/BlockAboutSupport
 374 ```
 375 Value (string):
 376 ```
 377 <enabled/>
 378 ```
 379 #### macOS
 380 ```
 381 <dict>
 382   <key>BlockAboutSupport</key>
 383   <true/> | <false/>
 384 </dict>
 385 ```
 386 #### policies.json
 387 ```
 388 {
 389   "policies": {
 390     "BlockAboutSupport": true | false
 391   }
 392 }
 393 ```
 394 ### Bookmarks
 395
 396 Add bookmarks in either the bookmarks toolbar or menu. Only `Title` and `URL` are required. If `Placement` is not specified, the bookmark will be placed on the toolbar. If `Folder` is specified, it is automatically created and bookmarks with the same folder name are grouped together.
 397
 398 **Compatibility:** Firefox 60, Firefox ESR 60\
 399 **CCK2 Equivalent:** `bookmarks.toolbar`,`bookmarks.menu`\
 400 **Preferences Affected:** N/A
 401
 402 #### Windows (GPO)
 403 ```
 404 Software\Policies\Mozilla\Firefox\Bookmarks\1\Title = "Example"
 405 Software\Policies\Mozilla\Firefox\Bookmarks\1\URL = "https://example.com"
 406 Software\Policies\Mozilla\Firefox\Bookmarks\1\Favicon = "https://example.com/favicon.ico"
 407 Software\Policies\Mozilla\Firefox\Bookmarks\1\Placement = "toolbar" | "menu"
 408 Software\Policies\Mozilla\Firefox\Bookmarks\1\Folder = "FolderName"
 409 ```
 410 #### macOS
 411 ```
 412 <dict>
 413   <key>Bookmarks</key>
 414   <array>
 415     <dict>
 416       <key>Title</key>
 417       <string>Example</string>
 418       <key>URL</key>
 419       <string>https://example.com</string>
 420       <key>Favicon</key>
 421       <string>https://example.com/favicon.ico</string>
 422       <key>Placement</key>
 423       <string>toolbar | menu</string>
 424       <key>Folder</key>
 425       <string>FolderName</string>
 426     </dict>
 427   </array>
 428 </dict>
 429 ```
 430 #### policies.json
 431 ```
 432 {
 433   "policies": {
 434     "Bookmarks": [
 435       {
 436         "Title": "Example",
 437         "URL": "https://example.com",
 438         "Favicon": "https://example.com/favicon.ico",
 439         "Placement": "toolbar" | "menu",
 440         "Folder": "FolderName"
 441       }
 442     ]
 443   }
 444 }
 445 ```
 446 ### CaptivePortal
 447 Enable or disable the detection of captive portals.
 448
 449 **Compatibility:** Firefox 67, Firefox ESR 60.7\
 450 **CCK2 Equivalent:** N/A\
 451 **Preferences Affected:** `network.captive-portal-service.enabled`
 452
 453 #### Windows (GPO)
 454 ```
 455 Software\Policies\Mozilla\Firefox\CaptivePortal = 0x1 | 0x0
 456 ```
 457 #### macOS
 458 ```
 459 <dict>
 460   <key>CaptivePortal</key>
 461   <true/> | <false/>
 462 </dict>
 463 ```
 464 #### policies.json
 465 ```
 466 {
 467   "policies": {
 468     "CaptivePortal": true | false
 469   }
 470 }
 471 ```
 472 ### Certificates
 473
 474 ### Certificates | ImportEnterpriseRoots
 475
 476 Trust certificates that have been added to the operating system certificate store by a user or administrator.
 477
 478 See https://support.mozilla.org/kb/setting-certificate-authorities-firefox for more detail.
 479
 480 **Compatibility:** Firefox 60, Firefox ESR 60 (macOS support in Firefox 63, Firefox ESR 68)\
 481 **CCK2 Equivalent:** N/A\
 482 **Preferences Affected:** `security.enterprise_roots.enabled`
 483
 484 #### Windows (GPO)
 485 ```
 486 Software\Policies\Mozilla\Firefox\Certificates\ImportEnterpriseRoots = 0x1 | 0x0
 487 ```
 488 #### macOS
 489 ```
 490 <dict>
 491   <key>Certificates</key>
 492   <dict>
 493     <key>ImportEnterpriseRoots</key>
 494     <true/> | <false/>
 495   </dict>
 496 </dict>
 497 ```
 498 #### policies.json
 499 ```
 500 {
 501   "policies": {
 502     "Certificates": {
 503       "ImportEnterpriseRoots": true | false
 504     }
 505   }
 506 }
 507 ```
 508 ### Certificates | Install
 509
 510 Install certificates into the Firefox certificate store. If only a filename is specified, Firefox searches for the file in the following locations:
 511
 512 - Windows
 513   - %USERPROFILE%\AppData\Local\Mozilla\Certificates
 514   - %USERPROFILE%\AppData\Roaming\Mozilla\Certificates
 515 - macOS
 516   - /Library/Application Support/Mozilla/Certificates
 517   - ~/Library/Application Support/Mozilla/Certificates
 518 - Linux
 519   - /usr/lib/mozilla/certificates
 520   - /usr/lib64/mozilla/certificates
 521   - ~/.mozilla/certificates
 522
 523 Starting with Firefox 65, Firefox 60.5 ESR, a fully qualified path can be used, including UNC paths. You should use the native path style for your operating system. We do not support using %USERPROFILE% or other environment variables on Windows.
 524
 525 If you are specifying the path in the policies.json file on Windows, you need to escape your backslashes (`\\`) which means that for UNC paths, you need to escape both (`\\\\`). If you use group policy, you only need one backslash.
 526
 527 Certificates are installed using the trust string `CT,CT,`.
 528
 529 Binary (DER) and ASCII (PEM) certificates are both supported.
 530
 531 **Compatibility:** Firefox 64, Firefox ESR 64\
 532 **CCK2 Equivalent:** `certs.ca`\
 533 **Preferences Affected:** N/A
 534
 535 #### Windows (GPO)
 536 ```
 537 Software\Policies\Mozilla\Firefox\Certificates\Install\1 = "cert1.der"
 538 Software\Policies\Mozilla\Firefox\Certificates\Install\2 = "C:\Users\username\cert2.pem"
 539 ```
 540 #### macOS
 541 ```
 542 <dict>
 543   <key>Certificates</key>
 544   <dict>
 545     <key>Install</key>
 546     <array>
 547       <string>cert1.der</string>
 548       <string>/Users/username/cert2.pem</string>
 549     </array>
 550   </dict>
 551 </dict>
 552 ```
 553 #### policies.json
 554 ```
 555 {
 556   "policies": {
 557     "Certificates": {
 558       "Install": ["cert1.der", "/home/username/cert2.pem"]
 559     }
 560   }
 561 }
 562 ```
 563 ### Cookies
 564 Configure cookie preferences.
 565
 566 `Allow` is a list of origins (not domains) where cookies are always allowed. You must include http or https.
 567
 568 `Block` is a list of origins (not domains) where cookies are always blocked. You must include http or https.
 569
 570 `Default` determines whether cookies are accepted at all.
 571
 572 `AcceptThirdParty` determines how third-party cookies are handled.
 573
 574 `ExpireAtSessionEnd` determines when cookies expire.
 575
 576 `RejectTracker` only rejects cookies for trackers.
 577
 578 `Locked` prevents the user from changing cookie preferences.
 579
 580 **Compatibility:** Firefox 60, Firefox ESR 60 (RejectTracker was added in Firefox 63)\
 581 **CCK2 Equivalent:** N/A\
 582 **Preferences Affected:** `network.cookie.cookieBehavior`,`network.cookie.lifetimePolicy`
 583
 584 #### Windows (GPO)
 585 ```
 586 Software\Policies\Mozilla\Firefox\Cookies\Allow\1 = "https://example.com"
 587 Software\Policies\Mozilla\Firefox\Cookies\Block\1 = "https://example.org"
 588 Software\Policies\Mozilla\Firefox\Cookies\Default = 0x1 | 0x0
 589 Software\Policies\Mozilla\Firefox\Cookies\AcceptThirdParty = "always" | "never" |"from-visited"
 590 Software\Policies\Mozilla\Firefox\Cookies\ExpireAtSessionEnd = 0x1 | 0x0
 591 Software\Policies\Mozilla\Firefox\Cookies\RejectTracker = 0x1 | 0x0
 592 Software\Policies\Mozilla\Firefox\Cookies\Locked = 0x1 | 0x0
 593 ```
 594 #### macOS
 595 ```
 596 <dict>
 597   <key>Cookies</key>
 598   <dict>
 599     <key>Allow</key>
 600     <array>
 601       <string>http://example.com</string>
 602     </array>
 603     <key>Block</key>
 604     <array>
 605       <string>http://example.org</string>
 606     </array>
 607     <key>Default</key>
 608     <true/> | <false/>
 609     <key>AcceptThirdParty</key>
 610     <string>always | never | from-visited</string>
 611     <key>ExpireAtSessionEnd</key>
 612     <true/> | <false/>
 613     <key>RejectTracker</key>
 614     <true/> | <false/>
 615     <key>Locked</key>
 616     <true/> | <false/>
 617   </dict>
 618 </dict>
 619 ```
 620 #### policies.json
 621 ```
 622 {
 623   "policies": {
 624     "Cookies": {
 625       "Allow": ["http://example.org/"],
 626       "Block": ["http://example.edu/"],
 627       "Default": true | false,
 628       "AcceptThirdParty": "always" | "never" | "from-visited"],
 629       "ExpireAtSessionEnd": true | false,
 630       "RejectTracker": true | false,
 631       "Locked": true | false
 632     }
 633   }
 634 }
 635 ```
 636 ### DisableSetDesktopBackground
 637 Remove the "Set As Desktop Background..." menuitem when right clicking on an image.
 638
 639 **Compatibility:** Firefox 60, Firefox ESR 60\
 640 **CCK2 Equivalent:** `removeSetDesktopBackground`\
 641 **Preferences Affected:** N/A
 642
 643 #### Windows (GPO)
 644 ```
 645 Software\Policies\Mozilla\Firefox\DisableSetDesktopBackground = 0x1 | 0x0
 646 ```
 647
 648 #### macOS
 649 ```
 650 <dict>
 651   <key>DisableSetDesktopBackground</key>
 652   <true/> | <false/>
 653 </dict>
 654 ```
 655 #### policies.json
 656 ```
 657 {
 658   "policies": {
 659     "DisableSetDesktopBackground": true | false
 660   }
 661 }
 662 ```
 663 ### DisableMasterPasswordCreation
 664 Remove the master password functionality.
 665
 666 **Compatibility:** Firefox 60, Firefox ESR 60\
 667 **CCK2 Equivalent:** `noMasterPassword`\
 668 **Preferences Affected:** N/A
 669
 670 #### Windows (GPO)
 671 ```
 672 Software\Policies\Mozilla\Firefox\DisableMasterPasswordCreation = 0x1 | 0x0
 673 ```
 674
 675 #### macOS
 676 ```
 677 <dict>
 678   <key>DisableMasterPasswordCreation</key>
 679   <true/> | <false/>
 680 </dict>
 681 ```
 682 #### policies.json
 683 ```
 684 {
 685   "policies": {
 686     "DisableMasterPasswordCreation": true | false
 687   }
 688 }
 689 ```
 690 ### DisableAppUpdate
 691 Turn off application updates.
 692
 693 **Compatibility:** Firefox 60, Firefox ESR 60\
 694 **CCK2 Equivalent:** `disableFirefoxUpdates`\
 695 **Preferences Affected:** N/A
 696
 697 #### Windows (GPO)
 698 ```
 699 Software\Policies\Mozilla\Firefox\DisableAppUpdate = 0x1 | 0x0
 700 ```
 701 #### macOS
 702 ```
 703 <dict>
 704   <key>DisableAppUpdate</key>
 705   <true/> | <false/>
 706 </dict>
 707 ```
 708 #### policies.json
 709 ```
 710 {
 711   "policies": {
 712     "DisableAppUpdate": true | false
 713   }
 714 }
 715 ```
 716 ### DisableBuiltinPDFViewer
 717 Disable the built in PDF viewer. PDF files are downloaded and sent externally.
 718
 719 **Compatibility:** Firefox 60, Firefox ESR 60\
 720 **CCK2 Equivalent:** `disablePDFjs`\
 721 **Preferences Affected:** `pdfjs.disabled`
 722
 723 #### Windows (GPO)
 724 ```
 725 Software\Policies\Mozilla\Firefox\DisableBuiltinPDFViewer = 0x1 | 0x0
 726 ```
 727
 728 #### macOS
 729 ```
 730 <dict>
 731   <key>DisableBuiltinPDFViewer</key>
 732   <true/> | <false/>
 733 </dict>
 734 ```
 735 #### policies.json
 736 ```
 737 {
 738   "policies": {
 739     "DisableBuiltinPDFViewer": true | false
 740   }
 741 }
 742 ```
 743 ### DisableDeveloperTools
 744 Remove access to all developer tools.
 745
 746 **Compatibility:** Firefox 60, Firefox ESR 60\
 747 **CCK2 Equivalent:** `removeDeveloperTools`\
 748 **Preferences Affected:** `devtools.policy.disabled`
 749
 750 #### Windows (GPO)
 751 ```
 752 Software\Policies\Mozilla\Firefox\DisableDeveloperTools = 0x1 | 0x0`
 753 ```
 754
 755 #### macOS
 756 ```
 757 <dict>
 758   <key>DisableDeveloperTools</key>
 759   <true/> | <false/>
 760 </dict>
 761 ```
 762 #### policies.json
 763 ```
 764 {
 765   "policies": {
 766     "DisableDeveloperTools": true | false
 767   }
 768 }
 769 ```
 770 ### DisableFeedbackCommands
 771 Disable the menus for reporting sites (Submit Feedback, Report Deceptive Site).
 772
 773 **Compatibility:** Firefox 60, Firefox ESR 60\
 774 **CCK2 Equivalent:** N/A\
 775 **Preferences Affected:** N/A
 776
 777 #### Windows (GPO)
 778 ```
 779 Software\Policies\Mozilla\Firefox\DisableFeedbackCommands = 0x1 | 0x0
 780 ```
 781 #### macOS
 782 ```
 783 <dict>
 784   <key>DisableFeedbackCommands</key>
 785   <true/> | <false/>
 786 </dict>
 787 ```
 788 #### policies.json
 789 ```
 790 {
 791   "policies": {
 792     "DisableFeedbackCommands": true | false
 793   }
 794 }
 795 ```
 796 ### DisableFirefoxScreenshots
 797 Remove access to Firefox Screenshots.
 798
 799 **Compatibility:** Firefox 60, Firefox ESR 60\
 800 **CCK2 Equivalent:** N/A\
 801 **Preferences Affected:** `extensions.screenshots.disabled`
 802
 803 #### Windows (GPO)
 804 ```
 805 Software\Policies\Mozilla\Firefox\DisableFirefoxScreenshots = 0x1 | 0x0
 806 ```
 807 #### macOS
 808 ```
 809 <dict>
 810   <key>DisableFirefoxScreenshots</key>
 811   <true/> | <false/>
 812 </dict>
 813 ```
 814 #### policies.json
 815 ```
 816 {
 817   "policies": {
 818     "DisableFirefoxScreenshots": true | false
 819   }
 820 }
 821 ```
 822 ### DisableFirefoxAccounts
 823 Disable Firefox Accounts integration (Sync).
 824
 825 **Compatibility:** Firefox 60, Firefox ESR 60\
 826 **CCK2 Equivalent:** `disableSync`\
 827 **Preferences Affected:** `identity.fxaccounts.enabled`
 828
 829 #### Windows (GPO)
 830 ```
 831 Software\Policies\Mozilla\Firefox\DisableFirefoxAccounts = 0x1 | 0x0
 832 ```
 833 #### macOS
 834 ```
 835 <dict>
 836   <key>DisableFirefoxAccounts</key>
 837   <true/> | <false/>
 838 </dict>
 839 ```
 840 #### policies.json
 841 ```
 842 {
 843   "policies": {
 844     "DisableFirefoxAccounts": true | false
 845   }
 846 }
 847 ```
 848 ### DisableFirefoxStudies
 849 Disable Firefox studies (Shield).
 850
 851 **Compatibility:** Firefox 60, Firefox ESR 60\
 852 **CCK2 Equivalent:** `disableForget`\
 853 **Preferences Affected:** N/A
 854
 855 #### Windows (GPO)
 856 ```
 857 Software\Policies\Mozilla\Firefox\DisableFirefoxStudies = 0x1 | 0x0
 858 ```
 859 #### macOS
 860 ```
 861 <dict>
 862   <key>DisableFirefoxStudies</key>
 863   <true/> | <false/>
 864 </dict>
 865 ```
 866 #### policies.json
 867 ```
 868 {
 869   "policies": {
 870     "DisableFirefoxStudies": true | false
 871   }
 872 }
 873 ```
 874 ### DisableForgetButton
 875 Disable the "Forget" button.
 876
 877 **Compatibility:** Firefox 60, Firefox ESR 60\
 878 **CCK2 Equivalent:** `disableForget`\
 879 **Preferences Affected:** N/A
 880
 881 #### Windows (GPO)
 882 ```
 883 Software\Policies\Mozilla\Firefox\DisableForgetButton = 0x1 | 0x0
 884 ```
 885 #### macOS
 886 ```
 887 <dict>
 888   <key>DisableForgetButton</key>
 889   <true/> | <false/>
 890 </dict>
 891 ```
 892 #### policies.json
 893 ```
 894 {
 895   "policies": {
 896     "DisableForgetButton": true | false
 897   }
 898 }
 899 ```
 900 ### DisableFormHistory
 901 Turn off saving information on web forms and the search bar.
 902
 903 **Compatibility:** Firefox 60, Firefox ESR 60\
 904 **CCK2 Equivalent:** `disableFormFill`\
 905 **Preferences Affected:** ` browser.formfill.enable`
 906
 907 #### Windows (GPO)
 908 ```
 909 Software\Policies\Mozilla\Firefox\DisableFormHistory = 0x1 | 0x0
 910 ```
 911 #### macOS
 912 ```
 913 <dict>
 914   <key>DisableFormHistory</key>
 915   <true/> | <false/>
 916 </dict>
 917 ```
 918 #### policies.json
 919 ```
 920 {
 921   "policies": {
 922     "DisableFormHistory": true | false
 923   }
 924 }
 925 ```
 926 ### DisablePasswordReveal
 927 Do not allow passwords to be shown in saved logins
 928
 929 **Compatibility:** Firefox 71, Firefox ESR 68.3\
 930 **CCK2 Equivalent:** N/A
 931 **Preferences Affected:** N/A
 932
 933 #### Windows (GPO)
 934 ```
 935 Software\Policies\Mozilla\Firefox\DisablePasswordReveal = 0x1 | 0x0
 936 ```
 937
 938 #### macOS
 939 ```
 940 <dict>
 941   <key>DisablePasswordReveal</key>
 942   <true/> | <false/>
 943 </dict>
 944 ```
 945 #### policies.json
 946 ```
 947 {
 948   "policies": {
 949     "DisablePasswordReveal": true | false
 950   }
 951 }
 952 ```
 953 ### DisablePocket
 954 Remove Pocket in the Firefox UI. It does not remove it from the new tab page.
 955
 956 **Compatibility:** Firefox 60, Firefox ESR 60\
 957 **CCK2 Equivalent:** `disablePocket`\
 958 **Preferences Affected:** `extensions.pocket.enabled`
 959
 960 #### Windows (GPO)
 961 ```
 962 Software\Policies\Mozilla\Firefox\DisablePocket = 0x1 | 0x0
 963 ```
 964 #### macOS
 965 ```
 966 <dict>
 967   <key>DisablePocket</key>
 968   <true/> | <false/>
 969 </dict>
 970 ```
 971 #### policies.json
 972 ```
 973 {
 974   "policies": {
 975     "DisablePocket": true | false
 976   }
 977 }
 978 ```
 979 ### DisablePrivateBrowsing
 980 Remove access to private browsing.
 981
 982 **Compatibility:** Firefox 60, Firefox ESR 60\
 983 **CCK2 Equivalent:** `disablePrivateBrowsing`\
 984 **Preferences Affected:** N/A
 985
 986 #### Windows (GPO)
 987 ```
 988 Software\Policies\Mozilla\Firefox\DisablePrivateBrowsing = 0x1 | 0x0
 989 ```
 990 #### macOS
 991 ```
 992 <dict>
 993   <key>DisablePrivateBrowsing</key>
 994   <true/> | <false/>
 995 </dict>
 996 ```
 997 #### policies.json
 998 ```
 999 {
1000   "policies": {
1001     "DisablePrivateBrowsing": true | false
1002   }
1003 }
1004 ```
1005 ### DisableProfileImport
1006 Disables the "Import data from another browser" option in the bookmarks window.
1007
1008 **Compatibility:** Firefox 60, Firefox ESR 60\
1009 **CCK2 Equivalent:** N/A\
1010 **Preferences Affected:** N/A
1011
1012 #### Windows (GPO)
1013 ```
1014 Software\Policies\Mozilla\Firefox\DisableProfileImport = 0x1 | 0x0
1015 ```
1016 #### macOS
1017 ```
1018 <dict>
1019   <key>DisableProfileImport</key>
1020   <true/> | <false/>
1021 </dict>
1022 ```
1023 #### policies.json
1024 ```
1025 {
1026   "policies": {
1027     "DisableProfileImport": true | false
1028   }
1029 }
1030 ```
1031 ### DisableProfileRefresh
1032 Disable the Refresh Firefox button on about:support and support.mozilla.org, as well as the prompt that displays offering to refresh Firefox when you haven't used it in a while.
1033
1034 **Compatibility:** Firefox 60, Firefox ESR 60\
1035 **CCK2 Equivalent:** `disableResetFirefox`\
1036 **Preferences Affected:** `browser.disableResetPrompt`
1037
1038 #### Windows (GPO)
1039 ```
1040 Software\Policies\Mozilla\Firefox\DisableProfileRefresh = 0x1 | 0x0
1041 ```
1042 #### macOS
1043 ```
1044 <dict>
1045   <key>DisableProfileRefresh</key>
1046   <true/> | <false/>
1047 </dict>
1048 ```
1049 #### policies.json
1050 ```
1051 {
1052   "policies": {
1053     "DisableProfileRefresh": true | false
1054   }
1055 }
1056 ```
1057 ### DisableSafeMode
1058 Disable safe mode within the browser.
1059
1060 On Windows, this disables safe mode via the command line as well.
1061
1062 **Compatibility:** Firefox 60, Firefox ESR 60 (Windows, macOS)\
1063 **CCK2 Equivalent:** `disableSafeMode`\
1064 **Preferences Affected:** N/A
1065
1066 #### Windows (GPO)
1067 ```
1068 Software\Policies\Mozilla\Firefox\DisableSafeMode = 0x1 | 0x0
1069 ```
1070 #### macOS
1071 ```
1072 <dict>
1073   <key>DisableSafeMode</key>
1074   <true/> | <false/>
1075 </dict>
1076 ```
1077 #### policies.json
1078 ```
1079 {
1080   "policies": {
1081     "DisableSafeMode": true | false
1082   }
1083 }
1084 ```
1085 ### DisableSecurityBypass
1086 Prevent the user from bypassing security in certain cases.
1087
1088 `InvalidCertificate` prevents adding an exception when an invalid certificate is shown.
1089
1090 `SafeBrowsing` prevents selecting "ignore the risk" and visiting a harmful site anyway.
1091
1092 **Compatibility:** Firefox 60, Firefox ESR 60\
1093 **CCK2 Equivalent:** N/A\
1094 **Preferences Affected:** `security.certerror.hideAddException`,`browser.safebrowsing.allowOverride`
1095
1096 #### Windows (GPO)
1097 ```
1098 Software\Policies\Mozilla\Firefox\DisableSecurityBypass\InvalidCertificate = 0x1 | 0x0
1099 Software\Policies\Mozilla\Firefox\DisableSecurityBypass\SafeBrowsing = 0x1 | 0x0
1100 ```
1101 #### macOS
1102 ```
1103 <dict>
1104   <key>DisableSecurityBypass</key>
1105   <dict>
1106     <key>InvalidCertificate</key>
1107     <true/> | <false/>
1108     <key><SafeBrowsing/key>
1109     <true/> | <false/>
1110   </dict>
1111 </dict>
1112 ```
1113 #### policies.json
1114 ```
1115 {
1116   "policies": {
1117     "DisableSecurityBypass": {
1118       "InvalidCertificate": true false,
1119       "SafeBrowsing": true false
1120     }
1121   }
1122 }
1123 ```
1124 ### DisableSystemAddonUpdate
1125 Prevent system add-ons from being installed or update.
1126
1127 **Compatibility:** Firefox 60, Firefox ESR 60\
1128 **CCK2 Equivalent:** N/A\
1129 **Preferences Affected:** N/A
1130
1131 #### Windows (GPO)
1132 ```Software\Policies\Mozilla\Firefox\DisableSystemAddonUpdate = 0x1 | 0x0
1133 ```
1134 #### macOS
1135 ```
1136 <dict>
1137   <key>DisableSystemAddonUpdate</key>
1138   <true/> | <false/>
1139 </dict>
1140 ```
1141 #### policies.json
1142 ```
1143 {
1144   "policies": {
1145     "DisableSystemAddonUpdate": true | false
1146   }
1147 }
1148 ```
1149 ### DisableTelemetry
1150 Prevent the upload of telemetry data.
1151
1152 Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
1153
1154 **Compatibility:** Firefox 60, Firefox ESR 60\
1155 **CCK2 Equivalent:** `disableTelemetry`\
1156 **Preferences Affected:** `datareporting.healthreport.uploadEnabled,datareporting.policy.dataSubmissionEnabled`
1157
1158 #### Windows (GPO)
1159 ```
1160 Software\Policies\Mozilla\Firefox\DisableTelemetry = 0x1 | 0x0
1161 ```
1162 #### macOS
1163 ```
1164 <dict>
1165   <key>DisableTelemetry</key>
1166   <true/> | <false/>
1167 </dict>
1168 ```
1169 #### policies.json
1170 ```
1171 {
1172   "policies": {
1173     "DisableTelemetry": true | false
1174   }
1175 }
1176 ```
1177 ### DisplayBookmarksToolbar
1178 Set the initial state of the bookmarks toolbar. A user can still hide it and it will stay hidden.
1179
1180 **Compatibility:** Firefox 60, Firefox ESR 60\
1181 **CCK2 Equivalent:** `displayBookmarksToolbar`\
1182 **Preferences Affected:** N/A
1183
1184 #### Windows (GPO)
1185 ```
1186 Software\Policies\Mozilla\Firefox\DisplayBookmarksToolbar = 0x1 | 0x0
1187 ```
1188 #### macOS
1189 ```
1190 <dict>
1191   <key>DisplayBookmarksToolbar</key>
1192   <true/> | <false/>
1193 </dict>
1194 ```
1195 #### policies.json
1196 ```
1197 {
1198   "policies": {
1199     "DisplayBookmarksToolbar": true | false
1200   }
1201 }
1202 ```
1203 ### DisplayMenuBar
1204 Set the initial state of the menubar. A user can still hide it and it will stay hidden.
1205
1206 **Compatibility:** Firefox 60, Firefox ESR 60 (Windows, some Linux)\
1207 **CCK2 Equivalent:** `displayMenuBar`\
1208 **Preferences Affected:** N/A
1209
1210 #### Windows (GPO)
1211 ```
1212 Software\Policies\Mozilla\Firefox\DisplayMenuBar = 0x1 | 0x0
1213 ```
1214 #### macOS
1215 ```
1216 <dict>
1217   <key>DisplayMenuBar</key>
1218   <true/> | <false/>
1219 </dict>
1220 ```
1221 #### policies.json
1222 ```
1223 {
1224   "policies": {
1225     "DisplayMenuBar": true | false
1226   }
1227 }
1228 ```
1229 ### DNSOverHTTPS
1230 Configure DNS over HTTPS.
1231
1232 `Enabled` determines whether DNS over HTTPS is enabled
1233
1234 `ProviderURL` is a URL to another provider.
1235
1236 `Locked` prevents the user from changing DNS over HTTPS preferences.
1237
1238 **Compatibility:** Firefox 63, Firefox ESR 68\
1239 **CCK2 Equivalent:** N/A\
1240 **Preferences Affected:** `network.trr.mode`,`network.trr.uri`
1241
1242 #### Windows (GPO)
1243 ```
1244 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Enabled = 0x1 | 0x0
1245 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\ProviderURL = "URL_TO_ALTERNATE_PROVIDER"
1246 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Locked = 0x1 | 0x0
1247 ```
1248 #### macOS
1249 ```
1250 <dict>
1251   <key>DNSOverHTTPS</key>
1252   <dict>
1253     <key>Enabled</key>
1254     <true/> | <false/>
1255     <key>ProviderURL</key>
1256     <string>URL_TO_ALTERNATE_PROVIDER</string>
1257     <key>Locked</key>
1258     <true/> | <false/>
1259   </dict>
1260 </dict>
1261 ```
1262 #### policies.json
1263 ```
1264 {
1265   "policies": {
1266     "DNSOverHTTPS": {
1267       "Enabled":  true | false,
1268       "ProviderURL": "URL_TO_ALTERNATE_PROVIDER",
1269       "Locked": true | false
1270     }
1271   }
1272 }
1273 ```
1274 ### DontCheckDefaultBrowser
1275 Don't check if Firefox is the default browser at startup.
1276
1277 **Compatibility:** Firefox 60, Firefox ESR 60\
1278 **CCK2 Equivalent:** `dontCheckDefaultBrowser`\
1279 **Preferences Affected:** `browser.shell.checkDefaultBrowser`
1280
1281 #### Windows (GPO)
1282 ```
1283 Software\Policies\Mozilla\Firefox\DontCheckDefaultBrowser = 0x1 | 0x0
1284 ```
1285 #### macOS
1286 ```
1287 <dict>
1288   <key>DontCheckDefaultBrowser</key>
1289   <true/> | <false/>
1290 </dict>
1291 ```
1292 #### policies.json
1293 ```
1294 {
1295   "policies": {
1296     "DontCheckDefaultBrowser": true | false
1297   }
1298 }
1299 ```
1300 ### DefaultDownloadDirectory
1301 Set the default download directory.
1302
1303 You can use ${home} for the native home directory.
1304
1305 **Compatibility:** Firefox 68, Firefox ESR 68\
1306 **CCK2 Equivalent:** N/A\
1307 **Preferences Affected:** `browser.download.dir`,`browser.download.folderList`
1308
1309 #### Windows (GPO)
1310 ```
1311 Software\Policies\Mozilla\Firefox\DefaultDownloadDirectory = "${home}\Downloads"
1312 ```
1313 #### macOS
1314 ```
1315 <dict>
1316   <key>DefaultDownloadDirectory</key>
1317   <string>${home}/Downloads</string>
1318 </dict>
1319 ```
1320 #### policies.json (macOS and Linux)
1321 ```
1322 {
1323   "policies": {
1324     "DefaultDownloadDirectory": "${home}/Downloads"
1325 }
1326 ```
1327 #### policies.json (Windows)
1328 ```
1329 {
1330   "policies": {
1331     "DefaultDownloadDirectory": "${home}\\Downloads"
1332 }
1333 ```
1334 ### DownloadDirectory
1335 Set and lock the download directory.
1336
1337 You can use ${home} for the native home directory.
1338
1339 **Compatibility:** Firefox 68, Firefox ESR 68\
1340 **CCK2 Equivalent:** N/A\
1341 **Preferences Affected:** `browser.download.dir`,`browser.download.folderList`,`browser.download.useDownloadDir`
1342
1343 #### Windows (GPO)
1344 ```
1345 Software\Policies\Mozilla\Firefox\DownloadDirectory = "${home}\Downloads"
1346 ```
1347 #### macOS
1348 ```
1349 <dict>
1350   <key>DownloadDirectory</key>
1351   <string>${home}/Downloads</string>
1352 </dict>
1353 ```
1354 #### policies.json (macOS and Linux)
1355 ```
1356 {
1357   "policies": {
1358     "DownloadDirectory": "${home}/Downloads"
1359 }
1360 ```
1361 #### policies.json (Windows)
1362 ```
1363 {
1364   "policies": {
1365     "DownloadDirectory": "${home}\\Downloads"
1366 }
1367 ```
1368 ### EnableTrackingProtection
1369 Configure tracking protection.
1370
1371 If this policy is not configured, tracking protection is not enabled by default in the browser, but it is enabled by default in private browsing and the user can change it.
1372
1373 If `Value` is set to false, tracking protection is disabled and locked in both the regular browser and private browsing.
1374
1375 If `Value` is set to true, tracking protection is enabled by default in both the regular browser and private browsing and the `Locked` value determines whether or not a user can change it.
1376
1377 If `Cryptomining` is set to true, cryptomining scripts on websites are blocked.
1378
1379 If `Fingerprinting` is set to true, fingerprinting scripts on websites are blocked.
1380
1381 **Compatibility:** Firefox 60, Firefox ESR 60 (Cryptomining and Fingerprinting added in 70/68.2)\
1382 **CCK2 Equivalent:** `dontCheckDefaultBrowser`\
1383 **Preferences Affected:** `privacy.trackingprotection.enabled`,`privacy.trackingprotection.pbmode.enabled`,`privacy.trackingprotection.cryptomining.enabled`,`privacy.trackingprotection.fingerprinting.enabled`
1384
1385 #### Windows (GPO)
1386 ```
1387 Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Value = 0x1 | 0x0
1388 Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Locked = 0x1 | 0x0
1389 Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Cryptomining = 0x1 | 0x0
1390 Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Fingerprinting = 0x1 | 0x0
1391 ```
1392 #### macOS
1393 ```
1394 <dict>
1395   <key>EnableTrackingProtection</key>
1396   <dict>
1397     <key>Value</key>
1398     <true/> | <false/>
1399     <key><Locked/key>
1400     <true/> | <false/>
1401     <key><Cryptomining/key>
1402     <true/> | <false/>
1403     <key><Fingerprinting/key>
1404     <true/> | <false/>
1405   </dict>
1406 </dict>
1407 ```
1408 #### policies.json
1409 ```
1410 {
1411   "policies": {
1412     "EnableTrackingProtection": {
1413       "Value": [true, false],
1414       "Locked": [true, false],
1415       "Cryptomining": [true, false],
1416       "Fingerprinting": [true, false]
1417     }
1418 }
1419 ```
1420 ### EnterprisePoliciesEnabled
1421 Enable policy support on macOS.
1422
1423 **Compatibility:** Firefox 63, Firefox ESR 60.3 (macOS only)\
1424 **CCK2 Equivalent:** N/A\
1425 **Preferences Affected:** N/A
1426
1427 #### macOS
1428 ```
1429 <dict>
1430   <key>EnterprisePoliciesEnabled</key>
1431   <true/>
1432 </dict>
1433 ```
1434 ### Extensions
1435 Control the installation, uninstallation and locking of extensions.
1436
1437 `Install` is a list of URLs or native paths for extensions to be installed.
1438
1439 `Uninstall` is a list of extension IDs that should be uninstalled if found.
1440
1441 `Locked` is a list of extension IDs that the user cannot disable or uninstall.
1442
1443 **Compatibility:** Firefox 60, Firefox ESR 60\
1444 **CCK2 Equivalent:** `addons`\
1445 **Preferences Affected:** N/A
1446
1447 #### Windows (GPO)
1448 ```
1449 Software\Policies\Mozilla\Firefox\Extensions\Install\1 = "https://addons.mozilla.org/firefox/downloads/somefile.xpi"
1450 Software\Policies\Mozilla\Firefox\Extensions\Install\2 = "//path/to/xpi"
1451 Software\Policies\Mozilla\Firefox\Extensions\Uninstall\1 = "bad_addon_id@mozilla.org"
1452 Software\Policies\Mozilla\Firefox\Extensions\Locked\1 = "addon_id@mozilla.org"
1453 ```
1454 #### macOS
1455 ```
1456 <dict>
1457   <key>Extensions</key>
1458   <dict>
1459     <key>Install</key>
1460     <array>
1461       <string>https://addons.mozilla.org/firefox/downloads/somefile.xpi</string>
1462       <string>//path/to/xpi</string>
1463     </array>
1464     <key>Uninstall</key>
1465     <array>
1466       <string>bad_addon_id@mozilla.org</string>
1467     </array>
1468     <key>Locked</key>
1469     <array>
1470       <string>addon_id@mozilla.org</string>
1471     </array>
1472   </dict>
1473 </dict>
1474 ```
1475 #### policies.json
1476 ```
1477 {
1478   "policies": {
1479     "Extensions": {
1480       "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"],
1481       "Uninstall": ["bad_addon_id@mozilla.org"],
1482       "Locked":  ["addon_id@mozilla.org"]
1483     }
1484   }
1485 }
1486 ```
1487 ### ExtensionSettings
1488 Manage all aspects of extensions. This policy is based heavily on the [Chrome policy](https://dev.chromium.org/administrators/policy-list-3/extension-settings-full) of the same name.
1489
1490 This policy maps an extension ID to its configuration. With an extension ID, the configuration will be applied to the specified extension only. A default configuration can be set for the special ID "*", which will apply to all extensions that don't have a custom configuration set in this policy.
1491
1492 To obtain an extension ID, install the extension and go to about:support. You will see the ID in the Extensions section.
1493
1494 The configuration for each extension is another dictionary that can contain the fields documented below.
1495
1496 | Name | Description |
1497 | --- | --- |
1498 | `installation_mode` | Maps to a string indicating the installation mode for the extension. The valid strings are `allowed`,`blocked`,`force_installed`, and `normal_installed`.
1499 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`allowed` | Allows the extension to be installed by the user. This is the default behavior.
1500 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`blocked`| Blocks installation of the extension and removes it from the device if already installed.
1501 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`force_installed`| The extension is automatically installed and can't be removed by the user. This option is not valid for the default configuration and requires an install_url.
1502 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`normal_installed`| The extension is automatically installed but can be disabled by the user. This option is not valid for the default configuration and requires an install_url.
1503 | `install_url`| Maps to a URL indicating where Firefox can download a force_installed or normal_installed extension. If installing from the addons.mozilla.org, use the following URL (substituting SHORT_NAME from the URL on AMO), https://addons.mozilla.org/firefox/downloads/latest/SHORT_NAME/latest.xpi. If installing from the local file system, use a file:/// URL. Languages packs are available from https://releases.mozilla.org/pub/firefox/releases/VERSION/PLATFORM/xpi/LANGUAGE.xpi.
1504 | `install_sources` | Each item in this list is an extension-style match pattern. Users will be able to easily install items from any URL that matches an item in this list. Both the location of the *.xpi file and the page where the download is started from (i.e.  the referrer) must be allowed by these patterns. This setting can be used only for the default configuration.
1505 | `allowed_types` | This setting whitelists the allowed types of extension/apps that can be installed in Firefox. The value is a list of strings, each of which should be one of the following: "extension", "theme", "dictionary", "langpack" This setting can be used only for the default configuration.
1506 | `blocked_install_message` | This maps to a string specifying the error message to display to users if they're blocked from installing an extension. This setting allows you to append text to the generic error message displayed when the extension is blocked. This could be be used to direct users to your help desk, explain why a particular extension is blocked, or something else.
1507
1508 **Compatibility:** Firefox 69, Firefox ESR 68.1\
1509 **CCK2 Equivalent:** N/A\
1510 **Preferences Affected:** N/A
1511
1512 #### Windows (GPO)
1513 ```
1514 Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) =
1515 {
1516   "*": {
1517     "blocked_install_message": "Custom error message.",
1518     "install_sources": ["https://addons.mozilla.org/"],
1519     "installation_mode": "blocked"
1520   },
1521   "uBlock0@raymondhill.net": {
1522     "installation_mode": "force_installed",
1523     "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi"
1524   }
1525 }
1526 ```
1527 #### macOS
1528 ```
1529 <dict>
1530   <key>ExtensionSettings</key>
1531   <dict>
1532     <key>*</key>
1533     <dict>
1534       <key>blocked_install_message</key>
1535       <string>Custom error message.</string>
1536       <key>install_sources</key>
1537       <array>
1538         <string>https://addons.mozilla.org/</string>
1539       </array>
1540       <key>installation_mode</key>
1541       <string>blocked</string>
1542     </dict>
1543     <key>uBlock0@raymondhill.net</key>
1544     <dict>
1545       <key>installation_mode</key>
1546        <string>force_installed</string>
1547       <key>install_url</key>
1548       <string>https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi</string>
1549     </dict>
1550   </dict>
1551 </dict>
1552 ```
1553 #### policies.json
1554 ```
1555 {
1556   "policies": {
1557     "ExtensionSettings": {
1558       "*": {
1559         "blocked_install_message": "Custom error message.",
1560         "install_sources": ["https://addons.mozilla.org/"],
1561         "installation_mode": "blocked"
1562       },
1563       "uBlock0@raymondhill.net": {
1564         "installation_mode": "force_installed",
1565         "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi"
1566       }
1567     }
1568   }
1569 }
1570 ```
1571 ### ExtensionUpdate
1572 Control extension updates.
1573
1574 **Compatibility:** Firefox 67, Firefox ESR 60.7\
1575 **CCK2 Equivalent:** N/A\
1576 **Preferences Affected:** `extensions.update.enabled`
1577
1578 #### Windows (GPO)
1579 ```
1580 Software\Policies\Mozilla\Firefox\ExtensionUpdate = 0x1 | 0x0
1581 ```
1582 #### macOS
1583 ```
1584 <dict>
1585   <key>ExtensionUpdate</key>
1586   <true/> | <false/>
1587 </dict>
1588 ```
1589 #### policies.json
1590 ```
1591 {
1592   "policies": {
1593     "ExtensionUpdate": true | false
1594   }
1595 }
1596 ```
1597 ### FlashPlugin
1598 Configure the default Flash plugin policy as well as origins for which Flash is allowed.
1599
1600 `Allow` is a list of origins where Flash are allowed.
1601
1602 `Block` is a list of origins where Flash is not allowed.
1603
1604 `Default` determines whether or not Flash is allowed by default.
1605
1606 `Locked` prevents the user from changing Flash preferences.
1607
1608 **Compatibility:** Firefox 60, Firefox ESR 60\
1609 **CCK2 Equivalent:** `permissions.plugin`\
1610 **Preferences Affected:** `plugin.state.flash`
1611
1612 #### Windows (GPO)
1613 ```
1614 Software\Policies\Mozilla\Firefox\FlashPlugin\Allow\1 = "https://example.org"
1615 Software\Policies\Mozilla\Firefox\FlashPlugin\Block\1 = "https://example.edu"
1616 Software\Policies\Mozilla\Firefox\FlashPlugin\Default = 0x1 | 0x0
1617 Software\Policies\Mozilla\Firefox\FlashPlugin\Locked = 0x1 | 0x0
1618 ```
1619 #### macOS
1620 ```
1621 <dict>
1622   <key>FlashPlugin</key>
1623   <dict>
1624     <key>Allow</key>
1625     <array>
1626       <string>http://example.org</string>
1627     </array>
1628     <key>Block</key>
1629     <array>
1630       <string>http://example.edu</string>
1631     </array>
1632     <key>Default</key>
1633     <true/> | <false/>
1634     <key>Locked</key>
1635     <true/> | <false/>
1636   </dict>
1637 </dict>
1638 ```
1639 #### policies.json
1640 ```
1641 {
1642   "policies": {
1643     "FlashPlugin": {
1644       "Allow": ["http://example.org/"],
1645       "Block": ["http://example.edu/"],
1646       "Default": true | false,
1647       "Locked": true | false
1648     }
1649   }
1650 }
1651 ```
1652 ### FirefoxHome
1653 Customize the Firefox Home page.
1654
1655 **Compatibility:** Firefox 68, Firefox ESR 68\
1656 **CCK2 Equivalent:** N/A\
1657 **Preferences Affected:** `browser.newtabpage.activity-stream.showSearch`,`browser.newtabpage.activity-stream.feeds.topsites`,`browser.newtabpage.activity-stream.feeds.section.highlights`,`browser.newtabpage.activity-stream.feeds.section.topstories`,`browser.newtabpage.activity-stream.feeds.snippets`
1658
1659 #### Windows (GPO)
1660 ```
1661 Software\Policies\Mozilla\Firefox\FirefoxHome\Search = 0x1 | 0x0
1662 Software\Policies\Mozilla\Firefox\FirefoxHome\TopSites = 0x1 | 0x0
1663 Software\Policies\Mozilla\Firefox\FirefoxHome\Highlights = 0x1 | 0x0
1664 Software\Policies\Mozilla\Firefox\FirefoxHome\Pocket = 0x1 | 0x0
1665 Software\Policies\Mozilla\Firefox\FirefoxHome\Snippets = 0x1 | 0x0
1666 Software\Policies\Mozilla\Firefox\FirefoxHome\Locked = 0x1 | 0x0
1667 ```
1668 #### macOS
1669 ```
1670 <dict>
1671   <key>FirefoxHome</key>
1672   <dict>
1673     <key>Search</key>
1674     <true/> | <false/>
1675     <key>TopSites</key>
1676     <true/> | <false/>
1677     <key>Highlights</key>
1678     <true/> | <false/>
1679     <key>Pocket</key>
1680     <true/> | <false/>
1681     <key>Snippets</key>
1682     <true/> | <false/>
1683     <key>Locked</key>
1684     <true/> | <false/>
1685   </dict>
1686 </dict>
1687 ```
1688 #### policies.json
1689 ```
1690 {
1691   "policies": {
1692     "FirefoxHome": {
1693       "Search": true | false,
1694       "TopSites": true | false,
1695       "Highlights": true | false,
1696       "Pocket": true | false,
1697       "Snippets": true | false,
1698       "Locked": true | false
1699     }
1700   }
1701 }
1702 ```
1703 ### HardwareAcceleration
1704 Control hardware acceleration.
1705
1706 **Compatibility:** Firefox 60, Firefox ESR 60\
1707 **CCK2 Equivalent:** N/A\
1708 **Preferences Affected:** `layers.acceleration.disabled`
1709
1710 #### Windows (GPO)
1711 ```
1712 Software\Policies\Mozilla\Firefox\HardwareAcceleration = 0x1 | 0x0
1713 ```
1714 #### macOS
1715 ```
1716 <dict>
1717   <key>HardwareAcceleration</key>
1718   <true/> | <false/>
1719 </dict>
1720 ```
1721 #### policies.json
1722 ```
1723 {
1724   "policies": {
1725     "HardwareAcceleration": true | false
1726   }
1727 }
1728 ```
1729 ### Homepage
1730 Configure the default homepage and how Firefox starts.
1731
1732 `URL` is the default homepage.
1733
1734 `Locked` prevents the user from changing homepage preferences.
1735
1736 `Additional` allows for more than one homepage.
1737
1738 `StartPage` is how Firefox starts. The choices are no homepage, the default homepage or the previous session.
1739
1740 **Compatibility:** Firefox 60, Firefox ESR 60 (StartPage was added in Firefox 60, Firefox ESR 60.4)\
1741 **CCK2 Equivalent:** `homePage`,`lockHomePage`\
1742 **Preferences Affected:** `browser.startup.homepage`,`browser.startup.page`
1743
1744 #### Windows (GPO)
1745 ```
1746 Software\Policies\Mozilla\Firefox\Homepage\URL = "https://example.com"
1747 Software\Policies\Mozilla\Firefox\Homepage\Locked = 0x1 | 0x0
1748 Software\Policies\Mozilla\Firefox\Homepage\Additional\1 = "https://example.org"
1749 Software\Policies\Mozilla\Firefox\Homepage\Additional\2 = "https://example.edu"
1750 Software\Policies\Mozilla\Firefox\Homepage\StartPage = "none" | "homepage" |  "previous-session"
1751 ```
1752 #### Windows (Intune)
1753 OMA-URI:
1754 ```
1755 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Homepage/HomepageURL
1756 ```
1757 Value (string):
1758 ```
1759 <enabled/>
1760
1761 <data id="HomepageURL" value="https://example.com"/>
1762 <data id="HomepageLocked" value="true | false"/>
1763 ```
1764 OMA-URI:
1765 ```
1766 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Homepage/HomepageAdditional
1767 ```
1768 Value (string):
1769 ```
1770 <enabled/>
1771
1772 <data id="HomepageAdditional" value="1&#xF000;http://example.org&#xF000;2&#xF000;http://example.edu"/>
1773 ```
1774 OMA-URI:
1775 ```
1776 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~Homepage/HomepageStartPage
1777 ```
1778 Value (string):
1779 ```
1780 <enabled/>
1781
1782 <data id="StartPage" value="none | homepage | previous-session"/>
1783 ```
1784 #### macOS
1785 ```
1786 <dict>
1787   <key>Homepage</key>
1788   <dict>
1789     <key>URL</key>
1790     <string>http://example.com</string>
1791     <key>Locked</key>
1792     <true/> | <false/>
1793     <key>Additional</key>
1794     <array>
1795       <string>http://example.org</string>
1796       <string>http://example.edu</string>
1797     </array>
1798     <key>StartPage</key>
1799     <string>none | homepage | previous-session</string>
1800   </dict>
1801 </dict>
1802 ```
1803 #### policies.json
1804 ```
1805 {
1806   "policies": {
1807     "Homepage": {
1808       "URL": "http://example.com/",
1809       "Locked": true | false,
1810       "Additional": ["http://example.org/",
1811                      "http://example.edu/"],
1812       "StartPage": "none" | "homepage" | "previous-session"
1813     }
1814   }
1815 }
1816 ```
1817 ### InstallAddonsPermission
1818 Configure the default extension install policy as well as origins for extension installs are allowed. This policy does not override turning off all extension installs.
1819
1820 `Allow` is a list of origins where extension installs are allowed.
1821
1822 `Default` determines whether or not extension installs are allowed by default.
1823
1824 **Compatibility:** Firefox 60, Firefox ESR 60\
1825 **CCK2 Equivalent:** `permissions.install`\
1826 **Preferences Affected:** `xpinstall.enabled`
1827
1828 #### Windows (GPO)
1829 ```
1830 Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Allow\1 = "https://example.org"
1831 Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Allow\2 = "https://example.edu"
1832 Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Default = 0x1 | 0x0
1833 ```
1834 #### macOS
1835 ```
1836 <dict>
1837   <key>InstallAddonsPermission</key>
1838   <dict>
1839     <key>Allow</key>
1840     <array>
1841       <string>http://example.org</string>
1842       <string>http://example.edu</string>
1843     </array>
1844     <key>Default</key>
1845     <true/> | <false/>
1846   </dict>
1847 </dict>
1848 ```
1849 #### policies.json
1850 ```
1851 {
1852   "policies": {
1853     "InstallAddonsPermission": {
1854       "Allow": ["http://example.org/",
1855                 "http://example.edu/"],
1856       "Default": true | false
1857     }
1858   }
1859 }
1860 ```
1861 ### LegacyProfiles
1862 Disable the feature enforcing a separate profile for each installation.
1863
1864 If this policy set to true, Firefox will not try to create different profiles for installations of Firefox in different directories. This is the equivalent of the MOZ_LEGACY_PROFILES environment variable.
1865
1866 If this policy set to false, Firefox will create a new profile for each unique installation of Firefox.
1867
1868 This policy only work on Windows via GPO (not policies.json).
1869
1870 **Compatibility:** Firefox 70, Firefox ESR 68.2 (Windows only, GPO only)\
1871 **CCK2 Equivalent:** N/A\
1872 **Preferences Affected:** N/A
1873
1874 #### Windows (GPO)
1875 ```
1876 Software\Policies\Mozilla\Firefox\LegacyProfiles = = 0x1 | 0x0
1877 ```
1878 ### LocalFileLinks
1879 Enable linking to local files by origin.
1880
1881 **Compatibility:** Firefox 68, Firefox ESR 68\
1882 **CCK2 Equivalent:** N/A\
1883 **Preferences Affected:** `capability.policy.localfilelinks.*`
1884
1885 #### Windows (GPO)
1886 ```
1887 Software\Policies\Mozilla\Firefox\LocalFileLinks\1 = "https://example.org"
1888 Software\Policies\Mozilla\Firefox\LocalFileLinks\2 = "https://example.edu"
1889 ```
1890 #### macOS
1891 ```
1892 <dict>
1893   <key>LocalFileLinks</key>
1894   <array>
1895     <string>http://example.org</string>
1896     <string>http://example.edu</string>
1897   </array>
1898 </dict>
1899 ```
1900 #### policies.json
1901 ```
1902 {
1903   "policies": {
1904     "LocalFileLinks": ["http://example.org/",
1905                        "http://example.edu/"]
1906   }
1907 }
1908 ```
1909 ### NoDefaultBookmarks
1910 Disable the creation of default bookmarks.
1911
1912 This policy is only effective if the user profile has not been created yet.
1913
1914 **Compatibility:** Firefox 60, Firefox ESR 60\
1915 **CCK2 Equivalent:** `removeDefaultBookmarks`\
1916 **Preferences Affected:** N/A
1917
1918 #### Windows (GPO)
1919 ```
1920 Software\Policies\Mozilla\Firefox\NoDefaultBookmarks = 0x1 | 0x0
1921 ```
1922 #### macOS
1923 ```
1924 <dict>
1925   <key>NoDefaultBookmarks</key>
1926   <true/> | <false/>
1927 </dict>
1928 ```
1929 #### policies.json
1930 ```
1931 {
1932   "policies": {
1933     "NoDefaultBookmarks": true | false
1934   }
1935 }
1936 ```
1937 ### NetworkPrediction
1938 Enable or disable network prediction (DNS prefetching).
1939
1940 **Compatibility:** Firefox 67, Firefox ESR 60.7\
1941 **CCK2 Equivalent:** N/A\
1942 **Preferences Affected:** `network.dns.disablePrefetch`,`network.dns.disablePrefetchFromHTTPS`
1943
1944 #### Windows (GPO)
1945 ```
1946 Software\Policies\Mozilla\Firefox\NetworkPrediction = 0x1 | 0x0
1947 ```
1948 #### macOS
1949 ```
1950 <dict>
1951   <key>NetworkPrediction</key>
1952   <true/> | <false/>
1953 </dict>
1954 ```
1955 #### policies.json
1956 ```
1957 {
1958   "policies": {
1959     "NetworkPrediction": true | false
1960 }
1961 ```
1962 ### NewTabPage
1963 Enable or disable the New Tab page.
1964
1965 **Compatibility:** Firefox 68, Firefox ESR 68\
1966 **CCK2 Equivalent:** N/A\
1967 **Preferences Affected:** `browser.newtabpage.enabled`
1968
1969 #### Windows (GPO)
1970 ```
1971 Software\Policies\Mozilla\Firefox\NewTabPage = 0x1 | 0x0
1972 ```
1973 #### macOS
1974 ```
1975 <dict>
1976   <key>NewTabPage</key>
1977   <true/> | <false/>
1978 </dict>
1979 ```
1980 #### policies.json
1981 ```
1982 {
1983   "policies": {
1984     "NewTabPage": true | false
1985 }
1986 ```
1987 ### OfferToSaveLogins
1988 Control whether or not Firefox offers to save passwords.
1989
1990 **Compatibility:** Firefox 60, Firefox ESR 60\
1991 **CCK2 Equivalent:** `dontRememberPasswords`\
1992 **Preferences Affected:** `signon.rememberSignons`
1993
1994 #### Windows (GPO)
1995 ```
1996 Software\Policies\Mozilla\Firefox\OfferToSaveLogins = 0x1 | 0x0
1997 ```
1998 #### macOS
1999 ```
2000 <dict>
2001   <key>OfferToSaveLogins</key>
2002   <true/> | <false/>
2003 </dict>
2004 ```
2005 #### policies.json
2006 ```
2007 {
2008   "policies": {
2009     "OfferToSaveLogins": true | false
2010   }
2011 }
2012 ```
2013 ### OfferToSaveLoginsDefault
2014 Sets the default value of signon.rememberSignons without locking it.
2015
2016 **Compatibility:** Firefox 70, Firefox ESR 60.2\
2017 **CCK2 Equivalent:** `dontRememberPasswords`\
2018 **Preferences Affected:** `signon.rememberSignons`
2019
2020 #### Windows (GPO)
2021 ```
2022 Software\Policies\Mozilla\Firefox\OfferToSaveLoginsDefault = 0x1 | 0x0
2023 ```
2024 #### macOS
2025 ```
2026 <dict>
2027   <key>OfferToSaveLoginsDefault</key>
2028   <true/> | <false/>
2029 </dict>
2030 ```
2031 #### policies.json
2032 ```
2033 {
2034   "policies": {
2035     "OfferToSaveLoginsDefault": true | false
2036   }
2037 }
2038 ```
2039 ### OverrideFirstRunPage
2040 Override the first run page. If the value is blank, no first run page is displayed.
2041
2042 **Compatibility:** Firefox 60, Firefox ESR 60\
2043 **CCK2 Equivalent:** `welcomePage`,`noWelcomePage`\
2044 **Preferences Affected:** `startup.homepage_welcome_url`
2045
2046 #### Windows (GPO)
2047 ```
2048 Software\Policies\Mozilla\Firefox\OverrideFirstRunPage = "http://example.org"
2049 ```
2050 #### macOS
2051 ```
2052 <dict>
2053   <key>OverrideFirstRunPage</key>
2054   <string>http://example.org</string>
2055 </dict>
2056 ```
2057 #### policies.json
2058 ```
2059 {
2060   "policies": {
2061     "OverrideFirstRunPage": "http://example.org"
2062 }
2063 ```
2064 ### OverridePostUpdatePage
2065 Override the upgrade page. If the value is blank, no upgrade page is displayed.
2066
2067 **Compatibility:** Firefox 60, Firefox ESR 60\
2068 **CCK2 Equivalent:** `upgradePage`,`noUpgradePage`\
2069 **Preferences Affected:** `startup.homepage_override_url`
2070
2071 #### Windows (GPO)
2072 ```
2073 Software\Policies\Mozilla\Firefox\OverridePostUpdatePage = "http://example.org"
2074 ```
2075 #### macOS
2076 ```
2077 <dict>
2078   <key>OverridePostUpdatePage</key>
2079   <string>http://example.org</string>
2080 </dict>
2081 ```
2082 #### policies.json
2083 ```
2084 {
2085   "policies": {
2086     "OverridePostUpdatePage": "http://example.org"
2087 }
2088 ```
2089 ### PasswordManagerEnabled
2090 Remove access to the password manager via preferences and blocks about:logins on Firefox 70.
2091
2092 **Compatibility:** Firefox 70, Firefox ESR 60.2\
2093 **CCK2 Equivalent:** N/A\
2094 **Preferences Affected:** `prefs.privacy.disable_button.view_passwords`
2095
2096 #### Windows (GPO)
2097 ```
2098 Software\Policies\Mozilla\Firefox\PasswordManagerEnabled = 0x1 | 0x0
2099 ```
2100 #### macOS
2101 ```
2102 <dict>
2103   <key>PasswordManagerEnabled</key>
2104   <true/> | <false/>
2105 </dict>
2106 ```
2107 #### policies.json
2108 ```
2109 {
2110   "policies": {
2111     "PasswordManagerEnabled": true | false
2112   }
2113 }
2114 ```
2115 ### Permissions
2116 Set permissions associated with camera, microphone, location, and notifications
2117
2118 `Allow` is a list of origins where the feature is allowed.
2119
2120 `Block` is a list of origins where the feature is not allowed.
2121
2122 `BlockNewRequests` determines whether or not new requests can be made for the feature.
2123
2124 `Locked` prevents the user from changing preferences for the feature.
2125
2126 **Compatibility:** Firefox 62, Firefox ESR 60.2\
2127 **CCK2 Equivalent:** N/A\
2128 **Preferences Affected:** `permissions.default.camera`,`permissions.default.microphone`,`permissions.default.geo`,`permissions.default.desktop-notification`
2129
2130 #### Windows (GPO)
2131 ```
2132 Software\Policies\Mozilla\Firefox\Permissions\Camera\Allow\1 = "https://example.org"
2133 Software\Policies\Mozilla\Firefox\Permissions\Camera\Block\1 = "https://example.edu"
2134 Software\Policies\Mozilla\Firefox\Permissions\Camera\BlockNewRequests = 0x1 | 0x0
2135 Software\Policies\Mozilla\Firefox\Permissions\Camera\Locked = 0x1 | 0x0
2136 Software\Policies\Mozilla\Firefox\Permissions\Microphone\Allow\1 = "https://example.org"
2137 Software\Policies\Mozilla\Firefox\Permissions\Microphone\Block\1 = "https://example.edu"
2138 Software\Policies\Mozilla\Firefox\Permissions\Microphone\BlockNewRequests = 0x1 | 0x0
2139 Software\Policies\Mozilla\Firefox\Permissions\Microphone\Locked = 0x1 | 0x0
2140 Software\Policies\Mozilla\Firefox\Permissions\Location\Allow\1 = "https://example.org"
2141 Software\Policies\Mozilla\Firefox\Permissions\Location\Block\1 = "https://example.edu"
2142 Software\Policies\Mozilla\Firefox\Permissions\Location\BlockNewRequests = 0x1 | 0x0
2143 Software\Policies\Mozilla\Firefox\Permissions\Location\Locked = 0x1 | 0x0
2144 Software\Policies\Mozilla\Firefox\Permissions\Notifications\Allow\1 = "https://example.org"
2145 Software\Policies\Mozilla\Firefox\Permissions\Notifications\Block\1 = "https://example.edu"
2146 Software\Policies\Mozilla\Firefox\Permissions\Notifications\BlockNewRequests = 0x1 | 0x0
2147 Software\Policies\Mozilla\Firefox\Permissions\Notifications\Locked = 0x1 | 0x0
2148 ```
2149 #### macOS
2150 ```
2151 <dict>
2152   <key>Permissions</key>
2153   <dict>
2154     <key>Camera</key>
2155     <dict>
2156       <key>Allow</key>
2157       <array>
2158         <string>https://example.org</string>
2159       </array>
2160       <key>Block</key>
2161       <array>
2162         <string>https://example.edu</string>
2163       </array>
2164       <key>BlockNewRequests</key>
2165       <true/>
2166       <key>Locked</key>
2167       <true/>
2168     </dict>
2169     <key>Microphone</key>
2170     <dict>
2171       <key>Allow</key>
2172       <array>
2173         <string>https://example.org</string>
2174       </array>
2175       <key>Block</key>
2176       <array>
2177         <string>https://example.edu</string>
2178       </array>
2179       <key>BlockNewRequests</key>
2180       <true/>
2181       <key>Locked</key>
2182       <true/>
2183     </dict>
2184     <key>Location</key>
2185     <dict>
2186       <key>Allow</key>
2187       <array>
2188         <string>https://example.org</string>
2189       </array>
2190       <key>Block</key>
2191       <array>
2192         <string>https://example.edu</string>
2193       </array>
2194       <key>BlockNewRequests</key>
2195       <true/>
2196       <key>Locked</key>
2197       <true/>
2198     </dict>
2199     <key>Notifications</key>
2200     <dict>
2201       <key>Allow</key>
2202       <array>
2203         <string>https://example.org</string>
2204       </array>
2205       <key>Block</key>
2206       <array>
2207         <string>https://example.edu</string>
2208       </array>
2209       <key>BlockNewRequests</key>
2210       <true/>
2211       <key>Locked</key>
2212       <true/>
2213     </dict>
2214   </dict>
2215 </dict>
2216 ```
2217 #### policies.json
2218 ```
2219 {
2220   "policies": {
2221     "Permissions": {
2222       "Camera": {
2223         "Allow": ["https://example.org"],
2224         "Block": ["https://example.edu"],
2225         "BlockNewRequests": true | false,
2226         "Locked": true | false
2227       },
2228       "Microphone": {
2229         "Allow": ["https://example.org"],
2230         "Block": ["https://example.edu"],
2231         "BlockNewRequests": true | false,
2232         "Locked": true | false
2233       },
2234       "Location": {
2235         "Allow": ["https://example.org"],
2236         "Block": ["https://example.edu"],
2237         "BlockNewRequests": true | false,
2238         "Locked": true | false
2239       },
2240       "Notifications": {
2241         "Allow": ["https://example.org"],
2242         "Block": ["https://example.edu"],
2243         "BlockNewRequests": true | false,
2244         "Locked": true | false
2245       }
2246     }
2247   }
2248 }
2249 ```
2250 ### PopupBlocking
2251 Configure the default pop-up window policy as well as origins for which pop-up windows are allowed.
2252
2253 `Allow` is a list of origins where popup-windows are allowed.
2254
2255 `Default` determines whether or not pop-up windows are allowed by default.
2256
2257 `Locked` prevents the user from changing pop-up preferences.
2258
2259 **Compatibility:** Firefox 60, Firefox ESR 60\
2260 **CCK2 Equivalent:** `permissions.popup`\
2261 **Preferences Affected:** `dom.disable_open_during_load`
2262
2263 #### Windows (GPO)
2264 ```
2265 Software\Policies\Mozilla\Firefox\PopupBlocking\Allow\1 = "https://example.org"
2266 Software\Policies\Mozilla\Firefox\PopupBlocking\Allow\2 = "https://example.edu"
2267 Software\Policies\Mozilla\Firefox\PopupBlocking\Default = 0x1 | 0x0
2268 Software\Policies\Mozilla\Firefox\PopupBlocking\Locked = 0x1 | 0x0
2269 ```
2270 #### macOS
2271 ```
2272 <dict>
2273   <key>PopupBlocking</key>
2274   <dict>
2275     <key>Allow</key>
2276     <array>
2277       <string>http://example.org</string>
2278       <string>http://example.edu</string>
2279     </array>
2280     <key>Default</key>
2281     <true/> | <false/>
2282     <key>Locked</key>
2283     <true/> | <false/>
2284   </dict>
2285 </dict>
2286 ```
2287 #### policies.json
2288 ```
2289 {
2290   "policies": {
2291     "PopupBlocking": {
2292       "Allow": ["http://example.org/",
2293                 "http://example.edu/"],
2294       "Default": true | false,
2295       "Locked": true | false
2296     }
2297   }
2298 }
2299 ```
2300 ### Preferences
2301 Set and lock certain preferences.
2302
2303 **Compatibility:** See below\
2304 **CCK2 Equivalent:** `preferences`\
2305 **Preferences Affected:** See below
2306
2307 | Preference | Type | Compatibility | Default
2308 | --- | --- | --- | ---
2309 | accessibility.force_disabled | integer | Firefox 70, Firefox ESR 68.2 | 0
2310 | &nbsp;&nbsp;&nbsp;&nbsp;If set to 1, platform accessibility is disabled.
2311 | app.update.auto | boolean | Firefox 68, Firefox ESR 68 | true
2312 | &nbsp;&nbsp;&nbsp;&nbsp;If false, Firefox doesn't automatically install update.
2313 | browser.bookmarks.autoExportHTML | boolean | Firefox 70, Firefox ESR 68.2 | false
2314 | &nbsp;&nbsp;&nbsp;&nbsp;If true, bookmarks are exported on shutdown.
2315 | browser.bookmarks.file | string | Firefox 70, Firefox ESR 68.2 | N/A
2316 | &nbsp;&nbsp;&nbsp;&nbsp;If set, the name of the file where bookmarks are exported and imported.
2317 | browser.bookmarks.restore_default_bookmarks | string | Firefox 70, Firefox ESR 68.2 | N/A
2318 | &nbsp;&nbsp;&nbsp;&nbsp;If true, bookmarks are restored to their defaults.
2319 | browser.cache.disk.enable | boolean | Firefox 68, Firefox ESR 68 | true
2320 | &nbsp;&nbsp;&nbsp;&nbsp;If false, don't store cache on the hard drive.
2321 | browser.cache.disk.parent_directory | string | Firefox 68, Firefox ESR 68 | Profile temporary directory
2322 | &nbsp;&nbsp;&nbsp;&nbsp;If set, changes the location of the disk cache.
2323 | browser.fixup.dns_first_for_single_words | boolean | Firefox 68, Firefox ESR 68 | false
2324 | &nbsp;&nbsp;&nbsp;&nbsp;If true, single words are sent to DNS, not directly to search.
2325 | browser.places.importBookmarksHTML | string | Firefox 70, Firefox ESR 68.2
2326 | &nbsp;&nbsp;&nbsp;&nbsp;If true, bookmarks are always imported on startup.
2327 | browser.safebrowsing.phishing.enabled | string | Firefox 70, Firefox ESR 68.2 | true
2328 | &nbsp;&nbsp;&nbsp;&nbsp;If false, phishing protection is not enabled (Not recommended)
2329 | browser.safebrowsing.malware.enabled | string | Firefox 70, Firefox ESR 68.2 | true
2330 | &nbsp;&nbsp;&nbsp;&nbsp;IF false, malware protection is not enabled (Not recommended)
2331 | browser.search.update | boolean | Firefox 68, Firefox ESR 68 | true
2332 | &nbsp;&nbsp;&nbsp;&nbsp;If false, updates for search engines are not checked.
2333 | browser.slowStartup.notificationDisabled | string | Firefox 70, Firefox ESR 68.2 | false
2334 | &nbsp;&nbsp;&nbsp;&nbsp;If true, a notification isn't shown if startup is slow.
2335 | browser.tabs.warnOnClose | boolean | Firefox 68, Firefox ESR 68 | true
2336 | &nbsp;&nbsp;&nbsp;&nbsp;If false, there is no warning when the browser is closed.
2337 | browser.taskbar.previews.enable | string | Firefox 70, Firefox ESR 68.2 (Windows only) | false
2338 | &nbsp;&nbsp;&nbsp;&nbsp;If true, tab previews are shown in the Windows taskbar.
2339 | browser.urlbar.suggest.bookmark | boolean | Firefox 68, Firefox ESR 68 | true
2340 | &nbsp;&nbsp;&nbsp;&nbsp;If false, bookmarks aren't suggested when typing in the URL bar.
2341 | browser.urlbar.suggest.history | boolean | Firefox 68, Firefox ESR 68 | true
2342 | &nbsp;&nbsp;&nbsp;&nbsp;If false, history isn't suggested when typing in the URL bar.
2343 | browser.urlbar.suggest.openpage | boolean | Firefox 68, Firefox ESR 68 | true
2344 | &nbsp;&nbsp;&nbsp;&nbsp;If false, open tabs aren't suggested when typing in the URL bar.
2345 | datareporting.policy.dataSubmissionPolicyBypassNotification | boolean | Firefox 68, Firefox ESR 68 | false
2346 | &nbsp;&nbsp;&nbsp;&nbsp;If true, don't show the privacy policy tab on first run.
2347 | dom.allow_scripts_to_close_windows | string | Firefox 70, Firefox ESR 68.2 | false
2348 | &nbsp;&nbsp;&nbsp;&nbsp;If false, web page can close windows.
2349 | dom.disable_window_flip | boolean | Firefox 68, Firefox ESR 68 | true
2350 | &nbsp;&nbsp;&nbsp;&nbsp;If false, web pages can focus and activate windows.
2351 | dom.disable_window_move_resize | boolean | Firefox 68, Firefox ESR 68 | false
2352 | &nbsp;&nbsp;&nbsp;&nbsp;If true, web pages can't move or resize windows.
2353 | dom.event.contextmenu.enabled | boolean | Firefox 68, Firefox ESR 68 | true
2354 | &nbsp;&nbsp;&nbsp;&nbsp;If false, web pages can't override context menus.
2355 | dom.keyboardevent.keypress.hack.dispatch_non_printable_keys.addl | string | Firefox 68, Firefox ESR 68 | N/A
2356 | &nbsp;&nbsp;&nbsp;&nbsp;See https://support.mozilla.org/en-US/kb/dom-events-changes-introduced-firefox-66
2357 | dom.keyboardevent.keypress.hack.use_legacy_keycode_and_charcode.addl | string | Firefox 68, Firefox ESR 68 | N/A
2358 | &nbsp;&nbsp;&nbsp;&nbsp;See https://support.mozilla.org/en-US/kb/dom-events-changes-introduced-firefox-66
2359 | extensions.blocklist.enabled | string | Firefox 70, Firefox ESR 68.2 | true
2360 | &nbsp;&nbsp;&nbsp;&nbsp;If false, the extensions blocklist is not used (Not recommended)
2361 | extensions.getAddons.showPane | boolean | Firefox 68, Firefox ESR 68 | N/A
2362 | &nbsp;&nbsp;&nbsp;&nbsp;If false, the Recommendations tab is not displayed in the Add-ons Manager.
2363 | geo.enabled | string | Firefox 70, Firefox ESR 68.2 | true
2364 | &nbsp;&nbsp;&nbsp;&nbsp;If false, the geolocation API is disabled. | Language dependent
2365 | intl.accept_languages | string | Firefox 70, Firefox ESR 68.2
2366 | &nbsp;&nbsp;&nbsp;&nbsp;If set, preferred language for web pages.
2367 | media.eme.enabled | string | Firefox 70, Firefox ESR 68.2 | true
2368 | &nbsp;&nbsp;&nbsp;&nbsp;If false, Encrypted Media Extensions are not enabled.
2369 | media.gmp-gmpopenh264.enabled | boolean | Firefox 68, Firefox ESR 68 | true
2370 | &nbsp;&nbsp;&nbsp;&nbsp;If false, the OpenH264  plugin is not downloaded.
2371 | media.gmp-widevinecdm.enabled | boolean | Firefox 68, Firefox ESR 68 | true
2372 | &nbsp;&nbsp;&nbsp;&nbsp;If false, the Widevine plugin is not downloaded.
2373 | network.dns.disableIPv6 | boolean | Firefox 68, Firefox ESR 68 | false
2374 | &nbsp;&nbsp;&nbsp;&nbsp;If true, IPv6 DNS lokoups are disabled.
2375 | network.IDN_show_punycode | boolean | Firefox 68, Firefox ESR 68 | false
2376 | &nbsp;&nbsp;&nbsp;&nbsp;If true, display the punycode version of internationalized domain names.
2377 | places.history.enabled | boolean | Firefox 68, Firefox ESR 68 | true
2378 | &nbsp;&nbsp;&nbsp;&nbsp;If false, history is not enabled.
2379 | print.save_print_settings | string | Firefox 70, Firefox ESR 68.2 | true
2380 | &nbsp;&nbsp;&nbsp;&nbsp;If false, print settings are not saved between jobs.
2381 | security.default_personal_cert | string | Firefox 68, Firefox ESR 68 | Ask Every Time
2382 | &nbsp;&nbsp;&nbsp;&nbsp;If set to Select Automatically, Firefox automatically chooses the default personal certificate.
2383 | security.mixed_content.block_active_content | string | Firefox 70, Firefox ESR 68.2 | true
2384 | &nbsp;&nbsp;&nbsp;&nbsp;If false, mixed active content (HTTP and HTTPS) is not blocked.
2385 | security.ssl.errorReporting.enabled | boolean | Firefox 68, Firefox ESR 68 | true
2386 | &nbsp;&nbsp;&nbsp;&nbsp;If false, SSL errors cannot be sent to Mozilla.
2387 | ui.key.menuAccessKeyFocuses | boolean | Firefox 68, Firefox ESR 68 | true
2388 | &nbsp;&nbsp;&nbsp;&nbsp;If false, the Alt key doesn't show the menubar on Windows.
2389 #### Windows (GPO)
2390 ```
2391 Software\Policies\Mozilla\Firefox\Preferences\boolean_preference_name = 0x1 | 0x0
2392 Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_value"
2393 ```
2394 #### macOS
2395 ```
2396 <dict>
2397   <key>Preferences</key>
2398   <dict>
2399     <key>boolean_preference_name</key>
2400     <true/> | <false/>
2401     <key>string_preference_name</key>
2402     <string>string_value</string>
2403   </dict>
2404 </dict>
2405 ```
2406 #### policies.json
2407 ```
2408 {
2409   "policies": {
2410     "Preferences": {
2411       "boolean_preference_name": true | false,
2412       "string_preference_name": "string_value"
2413     }
2414   }
2415 }
2416 ```
2417 ### PromptForDownloadLocation
2418 Ask where to save each file before downloading.
2419
2420 **Compatibility:** Firefox 68, Firefox ESR 68\
2421 **CCK2 Equivalent:** N/A
2422 **Preferences Affected:** `browser.download.useDownloadDir`
2423
2424 #### Windows (GPO)
2425 ```
2426 Software\Policies\Mozilla\Firefox\PromptForDownloadLocation = 0x1 | 0x0
2427 ```
2428 #### macOS
2429 ```
2430 <dict>
2431   <key>PromptForDownloadLocation</key>
2432   <true/> | <false/>
2433 </dict>
2434 ```
2435 #### policies.json
2436 ```
2437 {
2438   "policies": {
2439     "PromptForDownloadLocation": true | false
2440   }
2441 }
2442 ```
2443 ### Proxy
2444 Configure proxy settings. These settings correspond to the connection settings in Firefox preferences.
2445 To specify ports, append them to the hostnames with a colon (:).
2446
2447 `Mode` is the proxy method being used.
2448
2449 `Locked` is whether or not proxy settings can be changed.
2450
2451 `HTTPProxy` is the HTTP proxy server.
2452
2453 `UseHTTPProxyForAllProtocols` is whether or not the HTTP proxy should be used for all other proxies.
2454
2455 `SSLProxy` is the SSL proxy server.
2456
2457 `FTPProxy` is the FTP proxy server.
2458
2459 `SOCKSProxy` is the SOCKS proxy server
2460
2461 `SOCKSVersion` is the SOCKS version (4 or 5)
2462
2463 `Passthrough` is list of hostnames or IP addresses that will not be proxied. Use `<local>` to bypass proxying for all hostnames which do not contain periods.
2464
2465 `AutoConfigURL` is a  URL for proxy configuration (only used if Mode is autoConfig).
2466
2467 `AutoLogin` means do not prompt for authentication if password is saved.
2468
2469 `UseProxyForDNS` to use proxy DNS when using SOCKS v5.
2470
2471 **Compatibility:** Firefox 60, Firefox ESR 60\
2472 **CCK2 Equivalent:** `networkProxy*`\
2473 **Preferences Affected:** `network.proxy.type`,`network.proxy.autoconfig_url`,`network.proxy.socks_remote_dns`,`signon.autologin.proxy`,`network.proxy.socks_version`,`network.proxy.no_proxies_on`,`network.proxy.share_proxy_settings`,`network.proxy.http`,`network.proxy.http_port`,`network.proxy.ftp`,`network.proxy.ftp_port`,`network.proxy.ssl`,`network.proxy.ssl_port`,`network.proxy.socks`,`network.proxy.socks_port`
2474
2475 #### Windows (GPO)
2476 ```
2477 Software\Policies\Mozilla\Firefox\Proxy\Mode = "none", "system", "manual", "autoDetect", "autoConfig"
2478 Software\Policies\Mozilla\Firefox\Proxy\Locked = 0x1 | 0x0
2479 Software\Policies\Mozilla\Firefox\=Proxy\HTTPProxy = https://httpproxy.example.com
2480 Software\Policies\Mozilla\Firefox\Proxy\UseHTTPProxyForAllProtocols = 0x1 | 0x0
2481 Software\Policies\Mozilla\Firefox\Proxy\SSLProxy = https://sslproxy.example.com
2482 Software\Policies\Mozilla\Firefox\Proxy\FTPProxy = https://ftpproxy.example.com
2483 Software\Policies\Mozilla\Firefox\Proxy\SOCKSProxy = https://socksproxy.example.com
2484 Software\Policies\Mozilla\Firefox\Proxy\SOCKSVersion = 0x4 | 0x5
2485 Software\Policies\Mozilla\Firefox\Proxy\Passthrough = <local>
2486 Software\Policies\Mozilla\Firefox\Proxy\AutoConfigURL = URL_TO_AUTOCONFIG
2487 Software\Policies\Mozilla\Firefox\Proxy\AutoLogin = 0x1 | 0x0
2488 Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0
2489 ```
2490 #### macOS
2491 ```
2492 <dict>
2493   <key>Proxy</key>
2494   <dict>
2495     <key>Mode</key>
2496     <string>none | system | manual | autoDetect| autoConfig</string>
2497     <key>Locked</key>
2498     <true> | </false>
2499     <key>HTTPProxy</key>
2500     <string>https://httpproxy.example.com</string>
2501     <key>UseHTTPProxyForAllProtocols</key>
2502     <true> | </false>
2503     <key>SSLProxy</key>
2504     <string>https://sslproxy.example.com</string>
2505     <key>FTPProxy</key>
2506     <string>https://ftpproxy.example.com</string>
2507     <key>SOCKSProxy</key>
2508     <string>https://socksproxy.example.com</string>
2509     <key>SOCKSVersion</key>
2510     <string>4 | 5</string>
2511     <key>Passthrough</key>
2512     <string>&lt;local>&gt;</string>
2513     <key>AutoConfigURL</key>
2514     <string>URL_TO_AUTOCONFIG</string>
2515     <key>AutoLogin</key>
2516     <true> | </false>
2517     <key>UseProxyForDNS</key>
2518     <true> | </false>
2519   </dict>
2520 </dict>
2521 ```
2522 #### policies.json
2523 ```
2524 {
2525   "policies": {
2526     "Proxy": {
2527       "Mode": "none", "system", "manual", "autoDetect", "autoConfig",
2528       "Locked": [true, false],
2529       "HTTPProxy": "hostname",
2530       "UseHTTPProxyForAllProtocols": [true, false],
2531       "SSLProxy": "hostname",
2532       "FTPProxy": "hostname",
2533       "SOCKSProxy": "hostname",
2534       "SOCKSVersion": 4 | 5
2535       "Passthrough": "<local>",
2536       "AutoConfigURL": "URL_TO_AUTOCONFIG",
2537       "AutoLogin":  [true, false],
2538       "UseProxyForDNS": [true, false]
2539     }
2540   }
2541 }
2542 ```
2543 ### RequestedLocales
2544 Set the the list of requested locales for the application in order of preference. It will cause the corresponding language pack to become active.
2545
2546 Note: For Firefox 68, this can now be a string so that you can specify an empty value.
2547
2548 **Compatibility:** Firefox 64, Firefox ESR 60.4, Updated in Firefox 68, Firefox ESR 68\
2549 **CCK2 Equivalent:** N/A\
2550 **Preferences Affected:** N/A
2551 #### Windows (GPO)
2552 ```
2553 Software\Policies\Mozilla\Firefox\RequestedLocales\1 = "de"
2554 Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US"
2555
2556 or
2557
2558 Software\Policies\Mozilla\Firefox\RequestedLocales = "de,en-US"
2559 ```
2560 #### macOS
2561 ```
2562 <dict>
2563   <key>RequestedLocales</key>
2564   <array>
2565     <string>de</string>
2566     <string>en-US</string>
2567   </array>
2568 </dict>
2569
2570 or
2571
2572 <dict>
2573   <key>RequestedLocales</key>
2574   <string>de,en-US</string>
2575 </dict>
2576
2577 ```
2578 #### policies.json
2579 ```
2580 {
2581   "policies": {
2582     "RequestedLocales": ["de", "en-US"]
2583   }
2584 }
2585
2586 or
2587
2588 {
2589   "policies": {
2590     "RequestedLocales": "de,en-US"
2591   }
2592 }
2593 ```
2594 ### SanitizeOnShutdown (Selective)
2595 Clear data on shutdown. Choose from Cache, Cookies, Download History, Form & Search History, Browsing History, Active Logins, Site Preferences and Offline Website Data.
2596
2597 **Compatibility:** Firefox 68, Firefox ESR 68\
2598 **CCK2 Equivalent:** N/A\
2599 **Preferences Affected:** `privacy.sanitize.sanitizeOnShutdown`,`privacy.clearOnShutdown.cache`,`privacy.clearOnShutdown.cookies`,`privacy.clearOnShutdown.downloads`,`privacy.clearOnShutdown.formdata`,`privacy.clearOnShutdown.history`,`privacy.clearOnShutdown.sessions`,`privacy.clearOnShutdown.siteSettings`,`privacy.clearOnShutdown.offlineApps`
2600 #### Windows (GPO)
2601 ```
2602 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Cache = 0x1 | 0x0
2603 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Cookies = 0x1 | 0x0
2604 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Downloads = 0x1 | 0x0
2605 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\FormData = 0x1 | 0x0
2606 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\History = 0x1 | 0x0
2607 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Sessions = 0x1 | 0x0
2608 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\SiteSettings = 0x1 | 0x0
2609 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\OfflineApps = 0x1 | 0x0
2610 ```
2611 #### macOS
2612 ```
2613 <dict>
2614   <key>SanitizeOnShutdown</key>
2615   <dict>
2616     <key>Cache</key>
2617     <true/> | <false/>
2618     <key>Cookies</key>
2619     <true/> | <false/>
2620     <key>Downloads</key>
2621     <true/> | <false/>
2622     <key>FormData</key>
2623     <true/> | <false/>
2624     <key>History</key>
2625     <true/> | <false/>
2626     <key>Sessions</key>
2627     <true/> | <false/>
2628     <key>SiteSettings</key>
2629     <true/> | <false/>
2630     <key>OfflineApps</key>
2631     <true/> | <false/>
2632   </dict>
2633 </dict>
2634 ```
2635 #### policies.json
2636 ```
2637 {
2638   "policies": {
2639     "SanitizeOnShutdown": {
2640       "Cache": true | false,
2641       "Cookies": true | false,
2642       "Downloads": true | false,
2643       "FormData": true | false,
2644       "History": true | false,
2645       "Sessions": true | false,
2646       "SiteSettings": true | false,
2647       "OfflineApps": true | false
2648     }
2649   }
2650 }
2651 ```
2652 ### SanitizeOnShutdown (All)
2653 Clear all data on shutdown, including Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data.
2654
2655 **Compatibility:** Firefox 60, Firefox ESR 60\
2656 **CCK2 Equivalent:** N/A\
2657 **Preferences Affected:** `privacy.sanitize.sanitizeOnShutdown`,`privacy.clearOnShutdown.cache`,`privacy.clearOnShutdown.cookies`,`privacy.clearOnShutdown.downloads`,`privacy.clearOnShutdown.formdata`,`privacy.clearOnShutdown.history`,`privacy.clearOnShutdown.sessions`,`privacy.clearOnShutdown.siteSettings`,`privacy.clearOnShutdown.offlineApps`
2658 #### Windows (GPO)
2659 ```
2660 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown = 0x1 | 0x0
2661 ```
2662 #### macOS
2663 ```
2664 <dict>
2665   <key>SanitizeOnShutdown</key>
2666   <true/> | <false/>
2667 </dict>
2668 ```
2669 #### policies.json
2670 ```
2671 {
2672   "policies": {
2673     "SanitizeOnShutdown": true | false
2674   }
2675 }
2676 ```
2677 ### SearchBar
2678 Set whether or not search bar is displayed.
2679
2680 **Compatibility:** Firefox 60, Firefox ESR 60\
2681 **CCK2 Equivalent:** `showSearchBar`\
2682 **Preferences Affected:** N/A
2683
2684 #### Windows (GPO)
2685 ```
2686 Software\Policies\Mozilla\Firefox\SearchBar = "unified" | "separate"
2687 ```
2688 #### macOS
2689 ```
2690 <dict>
2691   <key>SearchBar</key>
2692   <string>unified | separate</string>
2693 </dict>
2694 ```
2695
2696 #### policies.json
2697 ```
2698 {
2699   "policies": {
2700     "SearchBar": "unified" | "separate"
2701   }
2702 }
2703 ```
2704
2705
2706
2707
2708
2709 ### SearchEngines (This policy is only available on the ESR.)
2710
2711 ### SearchEngines | Default
2712
2713 Set the default search engine. This policy is only available on the ESR.
2714
2715 **Compatibility:** Firefox ESR 60\
2716 **CCK2 Equivalent:** `defaultSearchEngine`\
2717 **Preferences Affected:** N/A
2718
2719 #### Windows (GPO)
2720 ```
2721 Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
2722 ```
2723 #### macOS
2724 ```
2725 <dict>
2726   <key>SearchEngines</key>
2727   <dict>
2728     <key>Default</key>
2729     <string>NAME_OF_SEARCH_ENGINE</string>
2730   </dict>
2731 </dict>
2732 ```
2733 #### policies.json
2734 ```
2735 {
2736   "policies": {
2737     "SearchEngines": {
2738       "Default": "NAME_OF_SEARCH_ENGINE"
2739     }
2740   }
2741 }
2742 ```
2743 ### SearchEngines | PreventInstalls
2744
2745 Prevent installing search engines from webpages.
2746
2747 **Compatibility:** Firefox ESR 60\
2748 **CCK2 Equivalent:** `disableSearchEngineInstall`\
2749 **Preferences Affected:** N/A
2750
2751 #### Windows (GPO)
2752 ```
2753 Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
2754 ```
2755 #### macOS
2756 ```
2757 <dict>
2758   <key>SearchEngines</key>
2759   <dict>
2760     <key>PreventInstalls</key>
2761     <true/> | <false/>
2762   </dict>
2763 </dict>
2764 ```
2765 #### policies.json
2766 ```
2767 {
2768   "policies": {
2769     "SearchEngines": {
2770       "PreventInstalls": true | false
2771     }
2772   }
2773 }
2774 ```
2775 ### SearchEngines | Remove
2776
2777 Hide built-in search engines. This policy is only available on the ESR.
2778
2779 **Compatibility:** Firefox ESR 60.2\
2780 **CCK2 Equivalent:** `removeDefaultSearchEngines` (removed all built-in engines)\
2781 **Preferences Affected:** N/A
2782
2783 #### Windows (GPO)
2784 ```
2785 Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
2786 ```
2787 #### macOS
2788 ```
2789 <dict>
2790   <key>SearchEngines</key>
2791   <dict>
2792     <key>Remove</key>
2793     <array>
2794       <string>NAME_OF_SEARCH_ENGINE</string>
2795     </array>
2796   </dict>
2797 </dict>
2798 ```
2799 #### policies.json
2800 ```
2801 {
2802   "policies": {
2803     "SearchEngines": {
2804       "Remove": ["NAME_OF_SEARCH_ENGINE"]
2805     }
2806   }
2807 }
2808 ```
2809 ### SearchEngines | Add
2810
2811 Add new search engines (up to five). This policy is only available on the ESR. `Name` and `URLTemplate` are required.
2812
2813 `Name` is the name of the search engine.
2814
2815 `URLTemplate` is the search URL with {searchTerms} to substitute for the search term.
2816
2817 `Method` is either GET or POST
2818
2819 `IconURL` is a URL for the icon to use.
2820
2821 `Alias` is a keyword to use for the engine.
2822
2823 `Description` is a description of the search engine.
2824
2825 `PostData` is the POST data as name value pairs separated by &.
2826
2827 `SuggestURLTemplate` is a search suggestions URL with {searchTerms} to substitute for the search term.
2828
2829 **Compatibility:** Firefox ESR 60 (POST support in Firefox ESR 68)\
2830 **CCK2 Equivalent:** `searchplugins`\
2831 **Preferences Affected:** N/A
2832
2833 #### Windows (GPO)
2834 ```
2835 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Name = "Example1"
2836 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\URLTemplate = "https://www.example.org/q={searchTerms}"
2837 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Method = "GET" | "POST"
2838 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\IconURL = "https://www.example.org/favicon.ico"
2839 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Alias = "example"
2840 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description = "Example Description"
2841 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "https://www.example.org/suggestions/q={searchTerms}"
2842 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\PostData = "name=value&q={searchTerms}"
2843 ```
2844
2845 #### macOS
2846 ```
2847 <dict>
2848   <key>SearchEngines</key>
2849   <dict>
2850     <key>Add</key>
2851     <array>
2852       <dict>
2853         <key>Name</key>
2854         <string>Example1</string>
2855         <key>URLTemplate</key>
2856         <string>https://www.example.org/q={searchTerms}</string>
2857         <key>Method</key>
2858         <string>GET | POST </string>
2859         <key>IconURL</key>
2860         <string>https://www.example.org/favicon.ico</string>
2861         <key>Alias</key>
2862         <string>example</string>
2863         <key>Description</key>
2864         <string>Example Description</string>
2865         <key>SuggestURLTemplate</key>
2866         <string>https://www.example.org/suggestions/q={searchTerms}</string>
2867         <key>PostData</key>
2868         <string>name=value&q={searchTerms}</string>
2869       </dict>
2870     <array>
2871   </dict>
2872 </dict>
2873 ```
2874 #### policies.json
2875 ```
2876 {
2877   "policies": {
2878     "SearchEngines": {
2879       "Add": [
2880         {
2881           "Name": "Example1",
2882           "URLTemplate": "https://www.example.org/q={searchTerms}",
2883           "Method": "GET" | "POST",
2884           "IconURL": "https://www.example.org/favicon.ico",
2885           "Alias": "example",
2886           "Description": "Description",
2887           "PostData": "name=value&q={searchTerms}",
2888           "SuggestURLTemplate": "https://www.example.org/suggestions/q={searchTerms}"
2889         }
2890       ]
2891     }
2892   }
2893 }
2894 ```
2895 ### SearchSuggestEnabled
2896
2897 Enable search suggestions.
2898
2899 **Compatibility:** Firefox 68, Firefox ESR 68\
2900 **CCK2 Equivalent:** N/A\
2901 **Preferences Affected:** `browser.urlbar.suggest.searches`,`browser.search.suggest.enabled`
2902
2903 #### Windows (GPO)
2904 ```
2905 Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
2906 ```
2907 #### macOS
2908 ```
2909 <dict>
2910   <key>SearchSuggestEnabled</key>
2911   <true/> | <false/>
2912 </dict>
2913 ```
2914 #### policies.json
2915 ```
2916 {
2917   "policies": {
2918     "SearchSuggestEnabled": true | false
2919   }
2920 }
2921 ```
2922 ### SecurityDevices
2923
2924 Install PKCS #11 modules.
2925
2926 **Compatibility:** Firefox 64, Firefox ESR 60.4\
2927 **CCK2 Equivalent:** `certs.devices`\
2928 **Preferences Affected:** N/A
2929
2930 #### Windows (GPO)
2931 ```
2932 Software\Policies\Mozilla\Firefox\SecurityDevices\NAME_OF_DEVICE = PATH_TO_LIBRARY_FOR_DEVICE
2933 ```
2934 #### macOS
2935 ```
2936 <dict>
2937   <key>SecurityDevices</key>
2938   <dict>
2939     <key>NAME_OF_DEVICE</key>
2940     <string>PATH_TO_LIBRARY_FOR_DEVICE</string>
2941   </dict>
2942 </dict>
2943 ```
2944
2945 #### policies.json
2946 ```
2947 {
2948   "policies": {
2949     "SecurityDevices": {
2950       "NAME_OF_DEVICE": "PATH_TO_LIBRARY_FOR_DEVICE"
2951     }
2952   }
2953 }
2954 ```
2955 ### SSLVersionMax
2956
2957 Set and lock the maximum version of TLS.
2958
2959 **Compatibility:** Firefox 66, Firefox ESR 60.6\
2960 **CCK2 Equivalent:** N/A\
2961 **Preferences Affected:** `security.tls.version.max`
2962
2963 #### Windows (GPO)
2964 ```
2965 Software\Policies\Mozilla\Firefox\SSLVersionMax = "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2966 ```
2967 #### macOS
2968 ```
2969 <dict>
2970   <key>SSLVersionMax</key>
2971   <string>tls1 | tls1.1 | tls1.2 | tls1.3</string>
2972 </dict>
2973 ```
2974
2975 #### policies.json
2976 ```
2977 {
2978   "policies": {
2979     "SSLVersionMax": "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2980   }
2981 }
2982 ```
2983 ### SSLVersionMin
2984
2985 Set and lock the minimum version of TLS.
2986
2987 **Compatibility:** Firefox 66, Firefox ESR 60.6\
2988 **CCK2 Equivalent:** N/A\
2989 **Preferences Affected:** `security.tls.version.min`
2990
2991 #### Windows (GPO)
2992 ```
2993 Software\Policies\Mozilla\Firefox\SSLVersionMin = "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2994 ```
2995 #### macOS
2996 ```
2997 <dict>
2998   <key>SSLVersionMin</key>
2999   <string>tls1 | tls1.1 | tls1.2 | tls1.3</string>
3000 </dict>
3001 ```
3002
3003 #### policies.json
3004 ```
3005 {
3006   "policies": {
3007     "SSLVersionMin": "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
3008   }
3009 }
3010 ```
3011 ### SupportMenu
3012 Add a menuitem to the help menu for specifying support information.
3013
3014 **Compatibility:** Firefox 68.0.1, Firefox ESR 68.0.1\
3015 **CCK2 Equivalent:** helpMenu\
3016 **Preferences Affected:** N/A
3017
3018 #### Windows (GPO)
3019 ```
3020 Software\Policies\Mozilla\Firefox\SupportMenu\Title = "Support Menu"
3021 Software\Policies\Mozilla\Firefox\SupportMenu\URL = "http://example.com/support"
3022 Software\Policies\Mozilla\Firefox\SupportMenu\AccessKey = "S"
3023 ```
3024 #### macOS
3025 ```
3026 <dict>
3027   <key>SupportMenu</key>
3028   <dict>
3029     <key>Title</key>
3030     <string>SupportMenu</string>
3031     <key>URL</key>
3032     <string>http://example.com/support</string>
3033     <key>AccessKey</key>
3034     <string>S</string>
3035   </dict>
3036 </dict>
3037 ```
3038 #### policies.json
3039 ```
3040 {
3041   "policies": {
3042     "SupportMenu": {
3043       "Title": "Support Menu",
3044       "URL": "http://example.com/support",
3045       "AccessKey": "S"
3046     }
3047   }
3048 }
3049 ```
3050 ### WebsiteFilter
3051 Block websites from being visited. The parameters take an array of Match Patterns, as documented in https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Match_patterns. Only http/https addresses are supported at the moment. The arrays are limited to 1000 entries each.
3052
3053 **Compatibility:** Firefox 60, Firefox ESR 60\
3054 **CCK2 Equivalent:** N/A\
3055 **Preferences Affected:** N/A
3056
3057 #### Windows (GPO)
3058 ```
3059 Software\Policies\Mozilla\Firefox\WebsiteFilters\Block\1 = "<all_urls>"
3060 Software\Policies\Mozilla\Firefox\WebsiteFilters\Exceptions\1 = "http://example.org/*"
3061 ```
3062 #### macOS
3063 ```
3064 <dict>
3065   <key>WebsiteFilter</key>
3066   <dict>
3067     <key>Block</key>
3068     <array>
3069       <string><all_urls></string>
3070     </array>
3071     <key>Exceptions</key>
3072     <array>
3073       <string>http://example.org/*</string>
3074     </array>
3075   </dict>
3076
3077 </dict>
3078 ```
3079 #### policies.json
3080 ```
3081 {
3082   "policies": {
3083     "WebsiteFilter": {
3084       "Block": ["<all_urls>"],
3085       "Exceptions": ["http://example.org/*"]
3086     }
3087   }
3088 }
3089 ```