]> git.p6c8.net - policy-templates.git/blob - README.md
4a900c2d50ec5c5882f7ced85e94441afd6791de
[policy-templates.git] / README.md
1 **IMPORTANT**: This file is in active development along with the policies in Firefox. Make sure to check the compatibility section to see if a policy is available in a specific version of Firefox. To get the policy information that corresponds to a specific release, go to https://github.com/mozilla/policy-templates/releases.
2
3 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.
4
5 | Policy Name | Description
6 | --- | --- |
7 | **[`AppUpdateURL`](#AppUpdateURL)** | Change the URL for application update.
8 | **[`Authentication`](#Authentication)** | Configure sites that support integrated authentication.
9 | **[`BlockAboutAddons`](#blockaboutaddons)** | Block access to the Add-ons Manager (about:addons).
10 | **[`BlockAboutConfig`](#blockaboutconfig)** | Block access to about:config.
11 | **[`BlockAboutProfiles`](#blockaboutprofiles)** | Block access to About Profiles (about:profiles).
12 | **[`BlockAboutSupport`](#blockaboutsupport)** | Block access to Troubleshooting Information (about:support).
13 | **[`Bookmarks`](#bookmarks)** | Add bookmarks in either the bookmarks toolbar or menu.
14 | **[`CaptivePortal`](#captiveportal)** | Enable or disable the detection of captive portals.
15 | **[`Certificates`](#certificates)** |
16 | **[`Certificates -> ImportEnterpriseRoots`](#certificates--importenterpriseroots)** | Trust certificates that have been added to the operating system certificate store by a user or administrator.
17 | **[`Certificates -> Install`](#certificates--install)** | Install certificates into the Firefox certificate store.
18 | **[`Cookies`](#cookies)** | Configure cookie preferences.
19 | **[`DisableSetDesktopBackground`](#disablesetdesktopbackground)** | Remove the "Set As Desktop Background..." menuitem when right clicking on an image.
20 | **[`DisableMasterPasswordCreation`](#disablemasterpasswordcreation)** | Remove the master password functionality.
21 | **[`DisableAppUpdate`](#disableappupdate)** | Turn off application updates.
22 | **[`DisableBuiltinPDFViewer`](#disablebuiltinpdfviewer)** | Disable the built in PDF viewer.
23 | **[`DisableDeveloperTools`](#disabledevelopertools)** | Remove access to all developer tools.
24 | **[`DisableFeedbackCommands`](#disablefeedbackcommands)** | Disable the menus for reporting sites.
25 | **[`DisableFirefoxScreenshots`](#disablefirefoxscreenshots)** | Remove access to Firefox Screenshots.
26 | **[`DisableFirefoxAccounts`](#disablefirefoxaccounts)** | Disable Firefox Accounts integration (Sync).
27 | **[`DisableFirefoxStudies`](#disablefirefoxstudies)** | Disable Firefox studies (Shield).
28 | **[`DisableForgetButton`](#disableforgetbutton)** | Disable the "Forget" button.
29 | **[`DisableFormHistory`](#disableformhistory)** | Turn off saving information on web forms and the search bar.
30 | **[`DisablePocket`](#disablepocket)** | Remove Pocket in the Firefox UI.
31 | **[`DisablePrivateBrowsing`](#disableprivatebrowsing)** | Remove access to private browsing.
32 | **[`DisableProfileImport`](#disableprofileimport)** | Disables the "Import data from another browser" option in the bookmarks window.
33 | **[`DisableProfileRefresh`](#disableprofilerefresh)** | Disable the Refresh Firefox button on about:support and support.mozilla.org
34 | **[`DisableSafeMode`](#disablesafemode)** | Disable safe mode within the browser.
35 | **[`DisableSecurityBypass`](#disablesecuritybypass)** | Prevent the user from bypassing security in certain cases.
36 | **[`DisableSystemAddonUpdate`](#disablesystemaddonupdate)** | Prevent system add-ons from being installed or update.
37 | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry
38 | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar.
39 | **[`DisplayMenuBar`](#displaymenubar)** | Set the initial state of the menubar
40 | **[`DNSOverHTTPS`](#dnsoverhttps)** | Configure DNS over HTTPS.
41 | **[`DontCheckDefaultBrowser`](#dontcheckdefaultbrowser)** | Don't check if Firefox is the default browser at startup.
42 | **[`EnableTrackingProtection`](#enabletrackingprotection)** | Configure tracking protection.
43 | **[`Extensions`](#extensions)** | Control the installation, uninstallation and locking of extensions.
44 | **[`ExtensionUpdate`](#extensionupdate)** | Control extension updates.
45 | **[`FlashPlugin`](#flashplugin)** | Configure the default Flash plugin policy as well as origins for which Flash is allowed.
46 | **[`HardwareAcceleration`](#hardwareacceleration)** | Control hardware acceleration.
47 | **[`Homepage`](#homepage)** | Configure the default homepage and how Firefox starts.
48 | **[`InstallAddonsPermission`](#installaddonspermission)** | Configure the default extension install policy as well as origins for extension installs are allowed.
49 | **[`LocalFileLinks`](#localfilelinks)** | Enable linking to local files by origin.
50 | **[`NetworkPrediction`](#networkprediction)** | Enable or disable network prediction (DNS prefetching).
51 | **[`NewTabPage`](#newtabpage)** | Enable or disable the New Tab page.
52 | **[`NoDefaultBookmarks`](#nodefaultbookmarks)** | Disable the creation of default bookmarks.
53 | **[`OfferToSaveLogins`](#offertosavelogins)** | Control whether or not Firefox offers to save passwords.
54 | **[`OverrideFirstRunPage`](#overridefirstrunpage)** | Override the first run page.
55 | **[`OverridePostUpdatePage`](#overridepostupdatepage)** | Override the upgrade page.
56 | **[`Permissions`](#permissions)** | Set permissions associated with camera, microphone, location, and notifications.
57 | **[`PopupBlocking`](#popupblocking)** | Configure the default pop-up window policy as well as origins for which pop-up windows are allowed.
58 | **[`Preferences`](#preferences)** | Set and lock some preferences.
59 | **[`Proxy`](#proxy)** | Configure proxy settings.
60 | **[`RequestedLocales`](#requestedlocales)** | Set the the list of requested locales for the application in order of preference.
61 | **[`SanitizeOnShutdown` (All)](#sanitizeonshutdown-all)** | Clear all data on shutdown.
62 | **[`SanitizeOnShutdown` (Selective)](#sanitizeonshutdown-selective)** | Clear data on shutdown.
63 | **[`SearchBar`](#searchbar)** | Set whether or not search bar is displayed.
64 | **[`SearchEngines`](#searchengines-this-policy-is-only-available-on-the-esr)** |
65 | **[`SearchEngines -> Default`](#searchengines--default)** | Set the default search engine.
66 | **[`SearchEngines -> PreventInstalls`](#searchengines--preventinstalls)** | Prevent installing search engines from webpages.
67 | **[`SearchEngines -> Remove`](#searchengines--remove)** | Hide built-in search engines.
68 | **[`SearchEngines -> Add`](#searchengines--add)** | Add new search engines.
69 | **[`SecurityDevices`](#securitydevices)** | Install PKCS #11 modules.
70 | **[`SearchSuggestEnabled`](#searchsuggestenabled)** | Enable search suggestions.
71 | **[`SSLVersionMax`](#sslversionmax)** | Set and lock the maximum version of TLS.
72 | **[`SSLVersionMin`](#sslversionmin)** | Set and lock the minimum version of TLS.
73 | **[`WebsiteFilter`](#websitefilter)** | Block websites from being visited.
74
75
76 ### AppUpdateURL
77
78 Change the URL for application update.
79
80 **Compatibility:** Firefox 62, Firefox ESR 60.2\
81 **CCK2 Equivalent:** N/A\
82 **Preferences Affected:** `app.update.url`
83
84 #### Windows
85 ```
86 Software\Policies\Mozilla\Firefox\AppUpdateURL = "https://yoursite.com"
87 ```
88 #### macOS
89 ```
90 <dict>
91 <key>AppUpdateURL</key>
92 <string>https://yoursite.com</string>
93 </dict>
94 ```
95 ### JSON
96 ```
97 {
98 "policies": {
99 "AppUpdateURL": "https://yoursite.com"
100 }
101 }
102 ```
103 ### Authentication
104
105 Configure sites that support integrated authentication.
106
107 See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
108
109 **Compatibility:** Firefox 60, Firefox ESR 60 (AllowNonFQDN added in 62/60.2)\
110 **CCK2 Equivalent:** N/A\
111 **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`
112
113 #### Windows
114 ```
115 Software\Policies\Mozilla\Firefox\Authentication\SPNEGO\1 = "mydomain.com"
116 Software\Policies\Mozilla\Firefox\Authentication\SPNEGO\2 = "https://myotherdomain.com"
117 Software\Policies\Mozilla\Firefox\Authentication\Delegated\1 = "mydomain.com"
118 Software\Policies\Mozilla\Firefox\Authentication\Delegated\2 = "https://myotherdomain.com"
119 Software\Policies\Mozilla\Firefox\Authentication\NTLM\1 = "mydomain.com"
120 Software\Policies\Mozilla\Firefox\Authentication\NTLM\2 = "https://myotherdomain.com"
121 Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\SPNEGO = 0x1 | 0x0
122 Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\NTLM = 0x1 | 0x0
123 ```
124 #### macOS
125 ```
126 <dict>
127 <key>Authentication</key>
128 <dict>
129 <key>SPNEGO</key>
130 <array>
131 <string>mydomain.com</string>
132 <string>https://myotherdomain.com</string>
133 </array>
134 <key>Delegated</key>
135 <array>
136 <string>mydomain.com</string>
137 <string>https://myotherdomain.com</string>
138 </array>
139 <key>NTLM</key>
140 <array>
141 <string>mydomain.com</string>
142 <string>https://myotherdomain.com</string>
143 </array>
144 <key>AllowNonFQDN</key>
145 <dict>
146 <key>SPNEGO</key>
147 <true/> | <false/>
148 <key>NTLM</key>
149 <true/> | <false/>
150 </dict>
151 </dict>
152 </dict>
153 ```
154 ### JSON
155 ```
156 {
157 "policies": {
158 "Authentication": {
159 "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
160 "Delegated": ["mydomain.com", "https://myotherdomain.com"],
161 "NTLM": ["mydomain.com", "https://myotherdomain.com"],
162 "AllowNonFQDN": {
163 "SPNEGO": true | false,
164 "NTLM": true | false
165 }
166 }
167 }
168 }
169 ```
170 ### BlockAboutAddons
171
172 Block access to the Add-ons Manager (about:addons).
173
174 **Compatibility:** Firefox 60, Firefox ESR 60\
175 **CCK2 Equivalent:** `disableAddonsManager`\
176 **Preferences Affected:** N/A
177
178 #### Windows
179 ```
180 Software\Policies\Mozilla\Firefox\BlockAboutAddons = 0x1 | 0x0
181 ```
182 #### macOS
183 ```
184 <dict>
185 <key>BlockAboutAddons</key>
186 <true/> | <false/>
187 </dict>
188 ```
189 #### JSON
190 ```
191 {
192 "policies": {
193 "BlockAboutAddons": true | false
194 }
195 }
196 ```
197 ### BlockAboutConfig
198
199 Block access to about:config.
200
201 **Compatibility:** Firefox 60, Firefox ESR 60\
202 **CCK2 Equivalent:** `disableAboutConfig`\
203 **Preferences Affected:** N/A
204
205 #### Windows
206 ```
207 Software\Policies\Mozilla\Firefox\BlockAboutConfig = 0x1 | 0x0
208 ```
209 #### macOS
210 ```
211 <dict>
212 <key>BlockAboutConfig</key>
213 <true/> | <false/>
214 </dict>
215 ```
216 #### JSON
217 ```
218 {
219 "policies": {
220 "BlockAboutConfig": true | false
221 }
222 }
223 ```
224 ### BlockAboutProfiles
225
226 Block access to About Profiles (about:profiles).
227
228 **Compatibility:** Firefox 60, Firefox ESR 60\
229 **CCK2 Equivalent:** `disableAboutProfiles`\
230 **Preferences Affected:** N/A
231
232 #### Windows
233 ```
234 Software\Policies\Mozilla\Firefox\BlockAboutProfiles = 0x1 | 0x0
235 ```
236 #### macOS
237 ```
238 <dict>
239 <key>BlockAboutProfiles</key>
240 <true/> | <false/>
241 </dict>
242 ```
243 #### JSON
244 ```
245 {
246 "policies": {
247 "BlockAboutProfiles": true | false
248 }
249 }
250 ```
251 ### BlockAboutSupport
252
253 Block access to Troubleshooting Information (about:support).
254
255 **Compatibility:** Firefox 60, Firefox ESR 60\
256 **CCK2 Equivalent:** `disableAboutSupport`\
257 **Preferences Affected:** N/A
258
259 #### Windows
260 ```
261 Software\Policies\Mozilla\Firefox\BlockAboutSupport = 0x1 | 0x0
262 ```
263 #### macOS
264 ```
265 <dict>
266 <key>BlockAboutSupport</key>
267 <true/> | <false/>
268 </dict>
269 ```
270 #### JSON
271 ```
272 {
273 "policies": {
274 "BlockAboutSupport": true | false
275 }
276 }
277 ```
278 ### Bookmarks
279
280 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.
281
282 **Compatibility:** Firefox 60, Firefox ESR 60\
283 **CCK2 Equivalent:** `bookmarks.toolbar`,`bookmarks.menu`\
284 **Preferences Affected:** N/A
285
286 #### Windows
287 ```
288 Software\Policies\Mozilla\Firefox\Bookmarks\1\Title = "Example"
289 Software\Policies\Mozilla\Firefox\Bookmarks\1\URL = "https://example.com"
290 Software\Policies\Mozilla\Firefox\Bookmarks\1\Favicon = "https://example.com/favicon.ico"
291 Software\Policies\Mozilla\Firefox\Bookmarks\1\Placement = "toolbar" | "menu"
292 Software\Policies\Mozilla\Firefox\Bookmarks\1\Folder = "FolderName"
293 ```
294 #### macOS
295 ```
296 <dict>
297 <key>Bookmarks</key>
298 <array>
299 <dict>
300 <key>Title</key>
301 <string>Example</string>
302 <key>URL</key>
303 <string>https://example.com</string>
304 <key>Favicon</key>
305 <string>https://example.com/favicon.ico</string>
306 <key>Placement</key>
307 <string>toolbar | menu</string>
308 <key>Folder</key>
309 <string>FolderName</string>
310 </dict>
311 </array>
312 </dict>
313 ```
314 ### JSON
315 ```
316 {
317 "policies": {
318 "Bookmarks": [
319 {
320 "Title": "Example",
321 "URL": "https://example.com",
322 "Favicon": "https://example.com/favicon.ico",
323 "Placement": "toolbar" | "menu",
324 "Folder": "FolderName"
325 }
326 ]
327 }
328 }
329 ```
330 ### CaptivePortal
331 Enable or disable the detection of captive portals.
332
333 **Compatibility:** Firefox 67, Firefox ESR 60.7\
334 **CCK2 Equivalent:** N/A\
335 **Preferences Affected:** `network.captive-portal-service.enabled`
336
337 #### Windows
338 ```
339 Software\Policies\Mozilla\Firefox\CaptivePortal = 0x1 | 0x0
340 ```
341 #### macOS
342 ```
343 <dict>
344 <key>CaptivePortal</key>
345 <true/> | <false/>
346 </dict>
347 ```
348 #### JSON
349 ```
350 {
351 "policies": {
352 "CaptivePortal": true | false
353 }
354 }
355 ```
356 ### Certificates
357
358 ### Certificates | ImportEnterpriseRoots
359
360 Trust certificates that have been added to the operating system certificate store by a user or administrator.
361
362 See https://support.mozilla.org/kb/setting-certificate-authorities-firefox for more detail.
363
364 **Compatibility:** Firefox 60, Firefox ESR 60 (macOS support in Firefox 63, Firefox ESR 68)\
365 **CCK2 Equivalent:** N/A\
366 **Preferences Affected:** `security.enterprise_roots.enabled`
367
368 #### Windows
369 ```
370 Software\Policies\Mozilla\Firefox\Certificates\ImportEnterpriseRoots = 0x1 | 0x0
371 ```
372 #### macOS
373 ```
374 <dict>
375 <key>Certificates</key>
376 <dict>
377 <key>ImportEnterpriseRoots</key>
378 <true/> | <false/>
379 </dict>
380 </dict>
381 ```
382 #### JSON
383 ```
384 {
385 "policies": {
386 "Certificates": {
387 "ImportEnterpriseRoots": true | false
388 }
389 }
390 }
391 ```
392 ### Certificates | Install
393
394 Install certificates into the Firefox certificate store. If only a filename is specified, Firefox searches for the file in the following locations:
395
396 - Windows
397 - %USERPROFILE%\AppData\Local\Mozilla\Certificates
398 - %USERPROFILE%\AppData\Roaming\Mozilla\Certificates
399 - macOS
400 - /Library/Application Support/Mozilla/Certificates
401 - ~/Library/Application Support/Mozilla/Certificates
402 - Linux
403 - /usr/lib/mozilla/certificates
404 - /usr/lib64/mozilla/certificates
405 - ~/.mozilla/certificates
406
407 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.
408
409 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.
410
411 Certificates are installed using the trust string `CT,CT,`.
412
413 Binary (DER) and ASCII (PEM) certificates are both supported.
414
415 **Compatibility:** Firefox 64, Firefox ESR 64\
416 **CCK2 Equivalent:** `certs.ca`\
417 **Preferences Affected:** N/A
418
419 #### Windows
420 ```
421 Software\Policies\Mozilla\Firefox\Certificates\Install\1 = "cert1.der"
422 Software\Policies\Mozilla\Firefox\Certificates\Install\2 = "C:\Users\username\cert2.pem"
423 ```
424 #### macOS
425 ```
426 <dict>
427 <key>Certificates</key>
428 <dict>
429 <key>Install</key>
430 <array>
431 <string>cert1.der</string>
432 <string>/Users/username/cert2.pem</string>
433 </array>
434 </dict>
435 </dict>
436 ```
437 #### JSON
438 ```
439 {
440 "policies": {
441 "Certificates": {
442 "Install": ["cert1.der", "/home/username/cert2.pem"]
443 }
444 }
445 }
446 ```
447 ### Cookies
448 Configure cookie preferences.
449
450 `Allow` is a list of origins (not domains) where cookies are always allowed. You must include http or https.
451
452 `Block` is a list of origins (not domains) where cookies are always blocked. You must include http or https.
453
454 `Default` determines whether cookies are accepted at all.
455
456 `AcceptThirdParty` determines how third-party cookies are handled.
457
458 `ExpireAtSessionEnd` determines when cookies expire.
459
460 `RejectTracker` only rejects cookies for trackers.
461
462 `Locked` prevents the user from changing cookie preferences.
463
464 **Compatibility:** Firefox 60, Firefox ESR 60 (RejectTracker was added in Firefox 63)\
465 **CCK2 Equivalent:** N/A\
466 **Preferences Affected:** `network.cookie.cookieBehavior`,`network.cookie.lifetimePolicy`
467
468 #### Windows
469 ```
470 Software\Policies\Mozilla\Firefox\Cookies\Allow\1 = "https://example.com"
471 Software\Policies\Mozilla\Firefox\Cookies\Block\1 = "https://example.org"
472 Software\Policies\Mozilla\Firefox\Cookies\Default = 0x1 | 0x0
473 Software\Policies\Mozilla\Firefox\Cookies\AcceptThirdParty = "always" | "never" |"from-visited"
474 Software\Policies\Mozilla\Firefox\Cookies\ExpireAtSessionEnd = 0x1 | 0x0
475 Software\Policies\Mozilla\Firefox\Cookies\RejectTracker = 0x1 | 0x0
476 Software\Policies\Mozilla\Firefox\Cookies\Locked = 0x1 | 0x0
477 ```
478 #### macOS
479 ```
480 <dict>
481 <key>Cookies</key>
482 <dict>
483 <key>Allow</key>
484 <array>
485 <string>http://example.com</string>
486 </array>
487 <key>Block</key>
488 <array>
489 <string>http://example.org</string>
490 </array>
491 <key>Default</key>
492 <true/> | <false/>
493 <key>AcceptThirdParty</key>
494 <string>always | never | from-visited</string>
495 <key>ExpireAtSessionEnd</key>
496 <true/> | <false/>
497 <key>RejectTracker</key>
498 <true/> | <false/>
499 <key>Locked</key>
500 <true/> | <false/>
501 </dict>
502 </dict>
503 ```
504 #### JSON
505 ```
506 {
507 "policies": {
508 "Cookies": {
509 "Allow": ["http://example.org/"],
510 "Block": ["http://example.edu/"],
511 "Default": true | false,
512 "AcceptThirdParty": "always" | "never" | "from-visited"],
513 "ExpireAtSessionEnd": true | false,
514 "RejectTracker": true | false,
515 "Locked": true | false
516 }
517 }
518 }
519 ```
520 ### DisableSetDesktopBackground
521 Remove the "Set As Desktop Background..." menuitem when right clicking on an image.
522
523 **Compatibility:** Firefox 60, Firefox ESR 60\
524 **CCK2 Equivalent:** `removeSetDesktopBackground`\
525 **Preferences Affected:** N/A
526
527 #### Windows
528 ```
529 Software\Policies\Mozilla\Firefox\DisableSetDesktopBackground = 0x1 | 0x0
530 ```
531
532 #### macOS
533 ```
534 <dict>
535 <key>DisableSetDesktopBackground</key>
536 <true/> | <false/>
537 </dict>
538 ```
539 #### JSON
540 ```
541 {
542 "policies": {
543 "DisableSetDesktopBackground": true | false
544 }
545 }
546 ```
547 ### DisableMasterPasswordCreation
548 Remove the master password functionality.
549
550 **Compatibility:** Firefox 60, Firefox ESR 60\
551 **CCK2 Equivalent:** `noMasterPassword`\
552 **Preferences Affected:** N/A
553
554 #### Windows
555 ```
556 Software\Policies\Mozilla\Firefox\DisableMasterPasswordCreation = 0x1 | 0x0
557 ```
558
559 #### macOS
560 ```
561 <dict>
562 <key>DisableMasterPasswordCreation</key>
563 <true/> | <false/>
564 </dict>
565 ```
566 #### JSON
567 ```
568 {
569 "policies": {
570 "DisableMasterPasswordCreation": true | false
571 }
572 }
573 ```
574 ### DisableAppUpdate
575 Turn off application updates.
576
577 **Compatibility:** Firefox 60, Firefox ESR 60\
578 **CCK2 Equivalent:** `disableFirefoxUpdates`\
579 **Preferences Affected:** N/A
580
581 #### Windows
582 ```
583 Software\Policies\Mozilla\Firefox\DisableAppUpdate = 0x1 | 0x0
584 ```
585 #### macOS
586 ```
587 <dict>
588 <key>DisableAppUpdate</key>
589 <true/> | <false/>
590 </dict>
591 ```
592 #### JSON
593 ```
594 {
595 "policies": {
596 "DisableAppUpdate": true | false
597 }
598 }
599 ```
600 ### DisableBuiltinPDFViewer
601 Disable the built in PDF viewer. PDF files are downloaded and sent externally.
602
603 **Compatibility:** Firefox 60, Firefox ESR 60\
604 **CCK2 Equivalent:** `disablePDFjs`\
605 **Preferences Affected:** `pdfjs.disabled`
606
607 #### Windows
608 ```
609 Software\Policies\Mozilla\Firefox\DisableBuiltinPDFViewer = 0x1 | 0x0
610 ```
611
612 #### macOS
613 ```
614 <dict>
615 <key>DisableBuiltinPDFViewer</key>
616 <true/> | <false/>
617 </dict>
618 ```
619 #### JSON
620 ```
621 {
622 "policies": {
623 "DisableBuiltinPDFViewer": true | false
624 }
625 }
626 ```
627 ### DisableDeveloperTools
628 Remove access to all developer tools.
629
630 **Compatibility:** Firefox 60, Firefox ESR 60\
631 **CCK2 Equivalent:** `removeDeveloperTools`\
632 **Preferences Affected:** `devtools.policy.disabled`
633
634 #### Windows
635 ```
636 Software\Policies\Mozilla\Firefox\DisableDeveloperTools = 0x1 | 0x0`
637 ```
638
639 #### macOS
640 ```
641 <dict>
642 <key>DisableDeveloperTools</key>
643 <true/> | <false/>
644 </dict>
645 ```
646 #### JSON
647 ```
648 {
649 "policies": {
650 "DisableDeveloperTools": true | false
651 }
652 }
653 ```
654 ### DisableFeedbackCommands
655 Disable the menus for reporting sites (Submit Feedback, Report Deceptive Site).
656
657 **Compatibility:** Firefox 60, Firefox ESR 60\
658 **CCK2 Equivalent:** N/A\
659 **Preferences Affected:** N/A
660
661 #### Windows
662 ```
663 Software\Policies\Mozilla\Firefox\DisableFeedbackCommands = 0x1 | 0x0
664 ```
665 #### macOS
666 ```
667 <dict>
668 <key>DisableFeedbackCommands</key>
669 <true/> | <false/>
670 </dict>
671 ```
672 #### JSON
673 ```
674 {
675 "policies": {
676 "DisableFeedbackCommands": true | false
677 }
678 }
679 ```
680 ### DisableFirefoxScreenshots
681 Remove access to Firefox Screenshots.
682
683 **Compatibility:** Firefox 60, Firefox ESR 60\
684 **CCK2 Equivalent:** N/A\
685 **Preferences Affected:** `extensions.screenshots.disabled`
686
687 #### Windows
688 ```
689 Software\Policies\Mozilla\Firefox\DisableFirefoxScreenshots = 0x1 | 0x0
690 ```
691 #### macOS
692 ```
693 <dict>
694 <key>DisableFirefoxScreenshots</key>
695 <true/> | <false/>
696 </dict>
697 ```
698 #### JSON
699 ```
700 {
701 "policies": {
702 "DisableFirefoxScreenshots": true | false
703 }
704 }
705 ```
706 ### DisableFirefoxAccounts
707 Disable Firefox Accounts integration (Sync).
708
709 **Compatibility:** Firefox 60, Firefox ESR 60\
710 **CCK2 Equivalent:** `disableSync`\
711 **Preferences Affected:** `identity.fxaccounts.enabled`
712
713 #### Windows
714 ```
715 Software\Policies\Mozilla\Firefox\DisableFirefoxAccounts = 0x1 | 0x0
716 ```
717 #### macOS
718 ```
719 <dict>
720 <key>DisableFirefoxAccounts</key>
721 <true/> | <false/>
722 </dict>
723 ```
724 #### JSON
725 ```
726 {
727 "policies": {
728 "DisableFirefoxAccounts": true | false
729 }
730 }
731 ```
732 ### DisableFirefoxStudies
733 Disable Firefox studies (Shield).
734
735 **Compatibility:** Firefox 60, Firefox ESR 60\
736 **CCK2 Equivalent:** `disableForget`\
737 **Preferences Affected:** N/A
738
739 #### Windows
740 ```
741 Software\Policies\Mozilla\Firefox\DisableFirefoxStudies = 0x1 | 0x0
742 ```
743 #### macOS
744 ```
745 <dict>
746 <key>DisableFirefoxStudies</key>
747 <true/> | <false/>
748 </dict>
749 ```
750 #### JSON
751 ```
752 {
753 "policies": {
754 "DisableFirefoxStudies": true | false
755 }
756 }
757 ```
758 ### DisableForgetButton
759 Disable the "Forget" button.
760
761 **Compatibility:** Firefox 60, Firefox ESR 60\
762 **CCK2 Equivalent:** `disableForget`\
763 **Preferences Affected:** N/A
764
765 #### Windows
766 ```
767 Software\Policies\Mozilla\Firefox\DisableForgetButton = 0x1 | 0x0
768 ```
769 #### macOS
770 ```
771 <dict>
772 <key>DisableForgetButton</key>
773 <true/> | <false/>
774 </dict>
775 ```
776 #### JSON
777 ```
778 {
779 "policies": {
780 "DisableForgetButton": true | false
781 }
782 }
783 ```
784 ### DisableFormHistory
785 Turn off saving information on web forms and the search bar.
786
787 **Compatibility:** Firefox 60, Firefox ESR 60\
788 **CCK2 Equivalent:** `disableFormFill`\
789 **Preferences Affected:** ` browser.formfill.enable`
790
791 #### Windows
792 ```
793 Software\Policies\Mozilla\Firefox\DisableFormHistory = 0x1 | 0x0
794 ```
795 #### macOS
796 ```
797 <dict>
798 <key>DisableFormHistory</key>
799 <true/> | <false/>
800 </dict>
801 ```
802 #### JSON
803 ```
804 {
805 "policies": {
806 "DisableFormHistory": true | false
807 }
808 }
809 ```
810 ### DisablePocket
811 Remove Pocket in the Firefox UI. It does not remove it from the new tab page.
812
813 **Compatibility:** Firefox 60, Firefox ESR 60\
814 **CCK2 Equivalent:** `disablePocket`\
815 **Preferences Affected:** `extensions.pocket.enabled`
816
817 #### Windows
818 ```
819 Software\Policies\Mozilla\Firefox\DisablePocket = 0x1 | 0x0
820 ```
821 #### macOS
822 ```
823 <dict>
824 <key>DisablePocket</key>
825 <true/> | <false/>
826 </dict>
827 ```
828 #### JSON
829 ```
830 {
831 "policies": {
832 "DisablePocket": true | false
833 }
834 }
835 ```
836 ### DisablePrivateBrowsing
837 Remove access to private browsing.
838
839 **Compatibility:** Firefox 60, Firefox ESR 60\
840 **CCK2 Equivalent:** `disablePrivateBrowsing`\
841 **Preferences Affected:** N/A
842
843 #### Windows
844 ```
845 Software\Policies\Mozilla\Firefox\DisablePrivateBrowsing = 0x1 | 0x0
846 ```
847 #### macOS
848 ```
849 <dict>
850 <key>DisablePrivateBrowsing</key>
851 <true/> | <false/>
852 </dict>
853 ```
854 #### JSON
855 ```
856 {
857 "policies": {
858 "DisablePrivateBrowsing": true | false
859 }
860 }
861 ```
862 ### DisableProfileImport
863 Disables the "Import data from another browser" option in the bookmarks window.
864
865 **Compatibility:** Firefox 60, Firefox ESR 60\
866 **CCK2 Equivalent:** N/A\
867 **Preferences Affected:** N/A
868
869 #### Windows
870 ```
871 Software\Policies\Mozilla\Firefox\DisableProfileImport = 0x1 | 0x0
872 ```
873 #### macOS
874 ```
875 <dict>
876 <key>DisableProfileImport</key>
877 <true/> | <false/>
878 </dict>
879 ```
880 #### JSON
881 ```
882 {
883 "policies": {
884 "DisableProfileImport": true | false
885 }
886 }
887 ```
888 ### DisableProfileRefresh
889 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.
890
891 **Compatibility:** Firefox 60, Firefox ESR 60\
892 **CCK2 Equivalent:** `disableResetFirefox`\
893 **Preferences Affected:** `browser.disableResetPrompt`
894
895 #### Windows
896 ```
897 Software\Policies\Mozilla\Firefox\DisableProfileRefresh = 0x1 | 0x0
898 ```
899 #### macOS
900 ```
901 <dict>
902 <key>DisableProfileRefresh</key>
903 <true/> | <false/>
904 </dict>
905 ```
906 #### JSON
907 ```
908 {
909 "policies": {
910 "DisableProfileRefresh": true | false
911 }
912 }
913 ```
914 ### DisableSafeMode
915 Disable safe mode within the browser.
916
917 On Windows, this disables safe mode via the command line as well.
918
919 **Compatibility:** Firefox 60, Firefox ESR 60 (Windows, macOS)\
920 **CCK2 Equivalent:** `disableSafeMode`\
921 **Preferences Affected:** N/A
922
923 #### Windows
924 ```
925 Software\Policies\Mozilla\Firefox\DisableSafeMode = 0x1 | 0x0
926 ```
927 #### macOS
928 ```
929 <dict>
930 <key>DisableSafeMode</key>
931 <true/> | <false/>
932 </dict>
933 ```
934 #### JSON
935 ```
936 {
937 "policies": {
938 "DisableSafeMode": true | false
939 }
940 }
941 ```
942 ### DisableSecurityBypass
943 Prevent the user from bypassing security in certain cases.
944
945 `InvalidCertificate` prevents adding an exception when an invalid certificate is shown.
946
947 `SafeBrowsing` prevents selecting "ignore the risk" and visiting a harmful site anyway.
948
949 **Compatibility:** Firefox 60, Firefox ESR 60\
950 **CCK2 Equivalent:** N/A\
951 **Preferences Affected:** `security.certerror.hideAddException`,`browser.safebrowsing.allowOverride`
952
953 #### Windows
954 ```
955 Software\Policies\Mozilla\Firefox\DisableSecurityBypass\InvalidCertificate = 0x1 | 0x0
956 Software\Policies\Mozilla\Firefox\DisableSecurityBypass\SafeBrowsing = 0x1 | 0x0
957 ```
958 #### macOS
959 ```
960 <dict>
961 <key>DisableSecurityBypass</key>
962 <dict>
963 <key>InvalidCertificate</key>
964 <true/> | <false/>
965 <key><SafeBrowsing/key>
966 <true/> | <false/>
967 </dict>
968 </dict>
969 ```
970 #### JSON
971 ```
972 {
973 "policies": {
974 "DisableSecurityBypass": {
975 "InvalidCertificate": true false,
976 "SafeBrowsing": true false
977 }
978 }
979 }
980 ```
981 ### DisableSystemAddonUpdate
982 Prevent system add-ons from being installed or update.
983
984 **Compatibility:** Firefox 60, Firefox ESR 60\
985 **CCK2 Equivalent:** N/A\
986 **Preferences Affected:** N/A
987
988 #### Windows
989 ```Software\Policies\Mozilla\Firefox\DisableSystemAddonUpdate = 0x1 | 0x0
990 ```
991 #### macOS
992 ```
993 <dict>
994 <key>DisableSystemAddonUpdate</key>
995 <true/> | <false/>
996 </dict>
997 ```
998 #### JSON
999 ```
1000 {
1001 "policies": {
1002 "DisableSystemAddonUpdate": true | false
1003 }
1004 }
1005 ```
1006 ### DisableTelemetry
1007 Prevent the upload of telemetry data.
1008
1009 Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
1010
1011 **Compatibility:** Firefox 60, Firefox ESR 60\
1012 **CCK2 Equivalent:** `disableTelemetry`\
1013 **Preferences Affected:** `datareporting.healthreport.uploadEnabled,datareporting.policy.dataSubmissionEnabled`
1014
1015 #### Windows
1016 ```
1017 Software\Policies\Mozilla\Firefox\DisableTelemetry = 0x1 | 0x0
1018 ```
1019 #### macOS
1020 ```
1021 <dict>
1022 <key>DisableTelemetry</key>
1023 <true/> | <false/>
1024 </dict>
1025 ```
1026 #### JSON
1027 ```
1028 {
1029 "policies": {
1030 "DisableTelemetry": true | false
1031 }
1032 }
1033 ```
1034 ### DisplayBookmarksToolbar
1035 Set the initial state of the bookmarks toolbar. A user can still hide it and it will stay hidden.
1036
1037 **Compatibility:** Firefox 60, Firefox ESR 60\
1038 **CCK2 Equivalent:** `displayBookmarksToolbar`\
1039 **Preferences Affected:** N/A
1040
1041 #### Windows
1042 ```
1043 Software\Policies\Mozilla\Firefox\DisplayBookmarksToolbar = 0x1 | 0x0
1044 ```
1045 #### macOS
1046 ```
1047 <dict>
1048 <key>DisplayBookmarksToolbar</key>
1049 <true/> | <false/>
1050 </dict>
1051 ```
1052 #### JSON
1053 ```
1054 {
1055 "policies": {
1056 "DisplayBookmarksToolbar": true | false
1057 }
1058 }
1059 ```
1060 ### DisplayMenuBar
1061 Set the initial state of the menubar. A user can still hide it and it will stay hidden.
1062
1063 **Compatibility:** Firefox 60, Firefox ESR 60 (Windows, some Linux)\
1064 **CCK2 Equivalent:** `displayMenuBar`\
1065 **Preferences Affected:** N/A
1066
1067 #### Windows
1068 ```
1069 Software\Policies\Mozilla\Firefox\DisplayMenuBar = 0x1 | 0x0
1070 ```
1071 #### macOS
1072 ```
1073 <dict>
1074 <key>DisplayMenuBar</key>
1075 <true/> | <false/>
1076 </dict>
1077 ```
1078 #### JSON
1079 ```
1080 {
1081 "policies": {
1082 "DisplayMenuBar": true | false
1083 }
1084 }
1085 ```
1086 ### DNSOverHTTPS
1087 Configure DNS over HTTPS.
1088
1089 `Enabled` determines whether DNS over HTTPS is enabled
1090
1091 `ProviderURL` is a URL to another provider.
1092
1093 `Locked` prevents the user from changing DNS over HTTPS preferences.
1094
1095 **Compatibility:** Firefox 63, Firefox ESR 68\
1096 **CCK2 Equivalent:** N/A\
1097 **Preferences Affected:** `network.trr.mode`,`network.trr.uri`
1098
1099 #### Windows
1100 ```
1101 Software\Policies\Mozilla\Firefox\Cookies\Enabled = 0x1 | 0x0
1102 Software\Policies\Mozilla\Firefox\Cookies\ProviderURL = "URL_TO_ALTERNATE_PROVIDER"
1103 Software\Policies\Mozilla\Firefox\Cookies\Locked = 0x1 | 0x0
1104 ```
1105 #### macOS
1106 ```
1107 <dict>
1108 <key>Cookies</key>
1109 <dict>
1110 <key>Enabled</key>
1111 <true/> | <false/>
1112 <key>ProviderURL</key>
1113 <string>URL_TO_ALTERNATE_PROVIDER</string>
1114 <key>Locked</key>
1115 <true/> | <false/>
1116 </dict>
1117 </dict>
1118 ```
1119 #### JSON
1120 ```
1121 {
1122 "policies": {
1123 "DNSOverHTTPS": {
1124 "Enabled": true | false,
1125 "ProviderURL": "URL_TO_ALTERNATE_PROVIDER",
1126 "Locked": true | false
1127 }
1128 }
1129 }
1130 ```
1131 ### DontCheckDefaultBrowser
1132 Don't check if Firefox is the default browser at startup.
1133
1134 **Compatibility:** Firefox 60, Firefox ESR 60\
1135 **CCK2 Equivalent:** `dontCheckDefaultBrowser`\
1136 **Preferences Affected:** `browser.shell.checkDefaultBrowser`
1137
1138 #### Windows
1139 ```
1140 Software\Policies\Mozilla\Firefox\DontCheckDefaultBrowser = 0x1 | 0x0
1141 ```
1142 #### macOS
1143 ```
1144 <dict>
1145 <key>DontCheckDefaultBrowser</key>
1146 <true/> | <false/>
1147 </dict>
1148 ```
1149 #### JSON
1150 ```
1151 {
1152 "policies": {
1153 "DontCheckDefaultBrowser": true | false
1154 }
1155 }
1156 ```
1157 ### EnableTrackingProtection
1158 Configure tracking protection.
1159
1160 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.
1161
1162 If `Value` is set to false, tracking protection is disabled and locked in both the regular browser and private browsing.
1163
1164 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.
1165
1166 **Compatibility:** Firefox 60, Firefox ESR 60\
1167 **CCK2 Equivalent:** `dontCheckDefaultBrowser`\
1168 **Preferences Affected:** `privacy.trackingprotection.enabled`,`privacy.trackingprotection.pbmode.enabled`
1169
1170 #### Windows
1171 ```
1172 Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Value = 0x1 | 0x0
1173 Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Locked = 0x1 | 0x0
1174 ```
1175 #### macOS
1176 ```
1177 <dict>
1178 <key>EnableTrackingProtection</key>
1179 <dict>
1180 <key>Value</key>
1181 <true/> | <false/>
1182
1183 <key><Locked/key>
1184 <true/> | <false/>
1185 </dict>
1186 </dict>
1187 ```
1188 #### JSON
1189 ```
1190 {
1191 "policies": {
1192 "EnableTrackingProtection": {
1193 "Value": [true, false],
1194 "Locked": [true, false]
1195 }
1196 }
1197 ```
1198 ### Extensions
1199 Control the installation, uninstallation and locking of extensions.
1200
1201 `Install` is a list of URLs or native paths for extensions to be installed.
1202
1203 `Uninstall` is a list of extension IDs that should be uninstalled if found.
1204
1205 `Locked` is a list of extension IDs that the user cannot disable or uninstall.
1206
1207 **Compatibility:** Firefox 60, Firefox ESR 60\
1208 **CCK2 Equivalent:** `addons`\
1209 **Preferences Affected:** N/A
1210
1211 #### Windows
1212 ```
1213 Software\Policies\Mozilla\Firefox\Extensions\Install\1 = "https://addons.mozilla.org/firefox/downloads/somefile.xpi"
1214 Software\Policies\Mozilla\Firefox\Extensions\Install\2 = "//path/to/xpi"
1215 Software\Policies\Mozilla\Firefox\Extensions\Uninstall\1 = "bad_addon_id@mozilla.org"
1216 Software\Policies\Mozilla\Firefox\Extensions\Locked\1 = "addon_id@mozilla.org"
1217 ```
1218 #### macOS
1219 ```
1220 <dict>
1221 <key>Extensions</key>
1222 <dict>
1223 <key>Install</key>
1224 <array>
1225 <string>https://addons.mozilla.org/firefox/downloads/somefile.xpi</string>
1226 <string>//path/to/xpi</string>
1227 </array>
1228 <key>Uninstall</key>
1229 <array>
1230 <string>bad_addon_id@mozilla.org</string>
1231 </array>
1232 <key>Locked</key>
1233 <array>
1234 <string>addon_id@mozilla.org</string>
1235 </array>
1236 </dict>
1237 </dict>
1238 ```
1239 #### JSON
1240
1241
1242 ```
1243 {
1244 "policies": {
1245 "Extensions": {
1246 "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"],
1247 "Uninstall": ["bad_addon_id@mozilla.org"],
1248 "Locked": ["addon_id@mozilla.org"]
1249 }
1250 }
1251 }
1252 ```
1253 ### ExtensionUpdate
1254 Control extension updates.
1255
1256 **Compatibility:** Firefox 67, Firefox ESR 60.7\
1257 **CCK2 Equivalent:** N/A\
1258 **Preferences Affected:** `extensions.update.enabled`
1259
1260 #### Windows
1261 ```
1262 Software\Policies\Mozilla\Firefox\ExtensionUpdate = 0x1 | 0x0
1263 ```
1264 #### macOS
1265 ```
1266 <dict>
1267 <key>ExtensionUpdate</key>
1268 <true/> | <false/>
1269 </dict>
1270 ```
1271 #### JSON
1272 ```
1273 {
1274 "policies": {
1275 "ExtensionUpdate": true | false
1276 }
1277 }
1278 ```
1279 ### FlashPlugin
1280 Configure the default Flash plugin policy as well as origins for which Flash is allowed.
1281
1282 `Allow` is a list of origins where Flash are allowed.
1283
1284 `Block` is a list of origins where Flash is not allowed.
1285
1286 `Default` determines whether or not Flash is allowed by default.
1287
1288 `Locked` prevents the user from changing Flash preferences.
1289
1290 **Compatibility:** Firefox 60, Firefox ESR 60\
1291 **CCK2 Equivalent:** `permissions.plugin`\
1292 **Preferences Affected:** `plugin.state.flash`
1293
1294 #### Windows
1295 ```
1296 Software\Policies\Mozilla\Firefox\FlashPlugin\Allow\1 = "https://example.org"
1297 Software\Policies\Mozilla\Firefox\FlashPlugin\Block\1 = "https://example.edu"
1298 Software\Policies\Mozilla\Firefox\FlashPlugin\Default = 0x1 | 0x0
1299 Software\Policies\Mozilla\Firefox\FlashPlugin\Locked = 0x1 | 0x0
1300 ```
1301 #### macOS
1302 ```
1303 <dict>
1304 <key>FlashPlugin</key>
1305 <dict>
1306 <key>Allow</key>
1307 <array>
1308 <string>http://example.org</string>
1309 </array>
1310 <key>Block</key>
1311 <array>
1312 <string>http://example.edu</string>
1313 </array>
1314 <key>Default</key>
1315 <true/> | <false/>
1316 <key>Locked</key>
1317 <true/> | <false/>
1318 </dict>
1319 </dict>
1320 ```
1321 #### JSON
1322 ```
1323 {
1324 "policies": {
1325 "FlashPlugin": {
1326 "Allow": ["http://example.org/"],
1327 "Block": ["http://example.edu/"],
1328 "Default": true | false,
1329 "Locked": true | false
1330 }
1331 }
1332 }
1333 ```
1334 ### HardwareAcceleration
1335 Control hardware acceleration.
1336
1337 **Compatibility:** Firefox 60, Firefox ESR 60\
1338 **CCK2 Equivalent:** N/A\
1339 **Preferences Affected:** `layers.acceleration.disabled`
1340
1341 #### Windows
1342 ```
1343 Software\Policies\Mozilla\Firefox\HardwareAcceleration = 0x1 | 0x0
1344 ```
1345 #### macOS
1346 ```
1347 <dict>
1348 <key>HardwareAcceleration</key>
1349 <true/> | <false/>
1350 </dict>
1351 ```
1352 #### JSON
1353 ```
1354 {
1355 "policies": {
1356 "HardwareAcceleration": true | false
1357 }
1358 }
1359 ```
1360 ### Homepage
1361 Configure the default homepage and how Firefox starts.
1362
1363 `URL` is the default homepage.
1364
1365 `Locked` prevents the user from changing homepage preferences.
1366
1367 `Additional` allows for more than one homepage.
1368
1369 `StartPage` is how Firefox starts. The choices are no homepage, the default homepage or the previous session.
1370
1371 **Compatibility:** Firefox 60, Firefox ESR 60 (StartPage was added in Firefox 60, Firefox ESR 60.4)\
1372 **CCK2 Equivalent:** `homePage`,`lockHomePage`\
1373 **Preferences Affected:** `browser.startup.homepage`,`browser.startup.page`
1374
1375 #### Windows
1376 ```
1377 Software\Policies\Mozilla\Firefox\Homepage\URL = "https://example.com"
1378 Software\Policies\Mozilla\Firefox\Homepage\Locked = 0x1 | 0x0
1379 Software\Policies\Mozilla\Firefox\Homepage\Additional\1 = "https://example.org"
1380 Software\Policies\Mozilla\Firefox\Homepage\Additional\2 = "https://example.edu"
1381 Software\Policies\Mozilla\Firefox\Homepage\StartPage = "none" | "homepage" | "previous-session"
1382 ```
1383 #### macOS
1384 ```
1385 <dict>
1386 <key>Homepage</key>
1387 <dict>
1388 <key>URL</key>
1389 <string>http://example.com</string>
1390 <key>Locked</key>
1391 <true/> | <false/>
1392 <key>Additional</key>
1393 <array>
1394 <string>http://example.org</string>
1395 <string>http://example.edu</string>
1396 </array>
1397 <key>StartPage</key>
1398 <string>always | never | from-visited</string>
1399 </dict>
1400 </dict>
1401 ```
1402 #### JSON
1403 ```
1404 {
1405 "policies": {
1406 "Homepage": {
1407 "URL": "http://example.com/",
1408 "Locked": true | false,
1409 "Additional": ["http://example.org/",
1410 "http://example.edu/"],
1411 "StartPage": "none" | "homepage" | "previous-session"
1412 }
1413 }
1414 }
1415 ```
1416 ### InstallAddonsPermission
1417 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.
1418
1419 `Allow` is a list of origins where extension installs are allowed.
1420
1421 `Default` determines whether or not extension installs are allowed by default.
1422
1423 **Compatibility:** Firefox 60, Firefox ESR 60\
1424 **CCK2 Equivalent:** `permissions.install`\
1425 **Preferences Affected:** `xpinstall.enabled`
1426
1427 #### Windows
1428 ```
1429 Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Allow\1 = "https://example.org"
1430 Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Allow\2 = "https://example.edu"
1431 Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Default = 0x1 | 0x0
1432 ```
1433 #### macOS
1434 ```
1435 <dict>
1436 <key>InstallAddonsPermission</key>
1437 <dict>
1438 <key>Allow</key>
1439 <array>
1440 <string>http://example.org</string>
1441 <string>http://example.edu</string>
1442 </array>
1443 <key>Default</key>
1444 <true/> | <false/>
1445 </dict>
1446 </dict>
1447 ```
1448 #### JSON
1449 ```
1450 {
1451 "policies": {
1452 "InstallAddonsPermission": {
1453 "Allow": ["http://example.org/",
1454 "http://example.edu/"],
1455 "Default": true | false
1456 }
1457 }
1458 }
1459 ```
1460 ### LocalFileLinks
1461 Enable linking to local files by origin.
1462
1463 **Compatibility:** Firefox 68, Firefox ESR 68\
1464 **CCK2 Equivalent:** N/A\
1465 **Preferences Affected:** `capability.policy.localfilelinks.*`
1466
1467 #### Windows
1468 ```
1469 Software\Policies\Mozilla\Firefox\LocalFileLinks\1 = "https://example.org"
1470 Software\Policies\Mozilla\Firefox\LocalFileLinks\2 = "https://example.edu"
1471 ```
1472 #### macOS
1473 ```
1474 <dict>
1475 <key>LocalFileLinks</key>
1476 <array>
1477 <string>http://example.org</string>
1478 <string>http://example.edu</string>
1479 </array>
1480 </dict>
1481 ```
1482 #### JSON
1483 ```
1484 {
1485 "policies": {
1486 "LocalFileLinks": ["http://example.org/",
1487 "http://example.edu/"]
1488 }
1489 }
1490 ```
1491 ### NoDefaultBookmarks
1492 Disable the creation of default bookmarks.
1493
1494 This policy is only effective if the user profile has not been created yet.
1495
1496 **Compatibility:** Firefox 60, Firefox ESR 60\
1497 **CCK2 Equivalent:** `removeDefaultBookmarks`\
1498 **Preferences Affected:** N/A
1499
1500 #### Windows
1501 ```
1502 Software\Policies\Mozilla\Firefox\NoDefaultBookmarks = 0x1 | 0x0
1503 ```
1504 #### macOS
1505 ```
1506 <dict>
1507 <key>NoDefaultBookmarks</key>
1508 <true/> | <false/>
1509 </dict>
1510 ```
1511 #### JSON
1512 ```
1513 {
1514 "policies": {
1515 "NoDefaultBookmarks": true | false
1516 }
1517 }
1518 ```
1519 ### NetworkPrediction
1520 Enable or disable network prediction (DNS prefetching).
1521
1522 **Compatibility:** Firefox 67, Firefox ESR 60.7\
1523 **CCK2 Equivalent:** N/A\
1524 **Preferences Affected:** `network.dns.disablePrefetch`,`network.dns.disablePrefetchFromHTTPS`
1525
1526 #### Windows
1527 ```
1528 Software\Policies\Mozilla\Firefox\NetworkPrediction = 0x1 | 0x0
1529 ```
1530 #### macOS
1531 ```
1532 <dict>
1533 <key>NetworkPrediction</key>
1534 <true/> | <false/>
1535 </dict>
1536 ```
1537 #### JSON
1538 ```
1539 {
1540 "policies": {
1541 "NetworkPrediction": true | false
1542 }
1543 ```
1544 ### NewTabPage
1545 Enable or disable the New Tab page.
1546
1547 **Compatibility:** Firefox 68, Firefox ESR 68\
1548 **CCK2 Equivalent:** N/A\
1549 **Preferences Affected:** `browser.newtabpage.enabled`
1550
1551 #### Windows
1552 ```
1553 Software\Policies\Mozilla\Firefox\NewTabPage = 0x1 | 0x0
1554 ```
1555 #### macOS
1556 ```
1557 <dict>
1558 <key>NewTabPage</key>
1559 <true/> | <false/>
1560 </dict>
1561 ```
1562 #### JSON
1563 ```
1564 {
1565 "policies": {
1566 "NewTabPage": true | false
1567 }
1568 ```
1569 ### OfferToSaveLogins
1570 Control whether or not Firefox offers to save passwords.
1571
1572 **Compatibility:** Firefox 60, Firefox ESR 60\
1573 **CCK2 Equivalent:** `dontRememberPasswords`\
1574 **Preferences Affected:** `signon.rememberSignons`
1575
1576 #### Windows
1577 ```
1578 Software\Policies\Mozilla\Firefox\OfferToSaveLogins = 0x1 | 0x0
1579 ```
1580 #### macOS
1581 ```
1582 <dict>
1583 <key>OfferToSaveLogins</key>
1584 <true/> | <false/>
1585 </dict>
1586 ```
1587 #### JSON
1588 ```
1589 {
1590 "policies": {
1591 "OfferToSaveLogins": true | false
1592 }
1593 }
1594 ```
1595 ### OverrideFirstRunPage
1596 Override the first run page. If the value is blank, no first run page is displayed.
1597
1598 **Compatibility:** Firefox 60, Firefox ESR 60\
1599 **CCK2 Equivalent:** `welcomePage`,`noWelcomePage`\
1600 **Preferences Affected:** `startup.homepage_welcome_url`
1601
1602 #### Windows
1603 ```
1604 Software\Policies\Mozilla\Firefox\OverrideFirstRunPage = "http://example.org"
1605 ```
1606 #### macOS
1607 ```
1608 <dict>
1609 <key>OverrideFirstRunPage</key>
1610 <string>http://example.org</string>
1611 </dict>
1612 ```
1613 #### JSON
1614 ```
1615 {
1616 "policies": {
1617 "OverrideFirstRunPage": ""http://example.org""
1618 }
1619 ```
1620 ### OverridePostUpdatePage
1621 Override the upgrade page. If the value is blank, no upgrade page is displayed.
1622
1623 **Compatibility:** Firefox 60, Firefox ESR 60\
1624 **CCK2 Equivalent:** `upgradePage`,`noUpgradePage`\
1625 **Preferences Affected:** `startup.homepage_override_url`
1626
1627 #### Windows
1628 ```
1629 Software\Policies\Mozilla\Firefox\OverridePostUpdatePage = "http://example.org"
1630 ```
1631 #### macOS
1632 ```
1633 <dict>
1634 <key>OverridePostUpdatePage</key>
1635 <string>http://example.org</string>
1636 </dict>
1637 ```
1638 #### JSON
1639 ```
1640 {
1641 "policies": {
1642 "OverridePostUpdatePage": ""http://example.org""
1643 }
1644 ```
1645 ### Permissions
1646 Set permissions associated with camera, microphone, location, and notifications
1647
1648 `Allow` is a list of origins where the feature is allowed.
1649
1650 `Block` is a list of origins where the feature is not allowed.
1651
1652 `BlockNewRequests` determines whether or not new requests can be made for the feature.
1653
1654 `Locked` prevents the user from changing preferences for the feature.
1655
1656 **Compatibility:** Firefox 62, Firefox ESR 60.2\
1657 **CCK2 Equivalent:** N/A\
1658 **Preferences Affected:** `permissions.default.camera`,`permissions.default.microphone`,`permissions.default.geo`,`permissions.default.desktop-notification`
1659
1660 #### Windows
1661 ```
1662 Software\Policies\Mozilla\Firefox\Permissions\Camera\Allow\1 = "https://example.org"
1663 Software\Policies\Mozilla\Firefox\Permissions\Camera\Block\1 = "https://example.edu"
1664 Software\Policies\Mozilla\Firefox\Permissions\Camera\BlockNewRequests = 0x1 | 0x0
1665 Software\Policies\Mozilla\Firefox\Permissions\Camera\Locked = 0x1 | 0x0
1666 Software\Policies\Mozilla\Firefox\Permissions\Microphone\Allow\1 = "https://example.org"
1667 Software\Policies\Mozilla\Firefox\Permissions\Microphone\Block\1 = "https://example.edu"
1668 Software\Policies\Mozilla\Firefox\Permissions\Microphone\BlockNewRequests = 0x1 | 0x0
1669 Software\Policies\Mozilla\Firefox\Permissions\Microphone\Locked = 0x1 | 0x0
1670 Software\Policies\Mozilla\Firefox\Permissions\Location\Allow\1 = "https://example.org"
1671 Software\Policies\Mozilla\Firefox\Permissions\Location\Block\1 = "https://example.edu"
1672 Software\Policies\Mozilla\Firefox\Permissions\Location\BlockNewRequests = 0x1 | 0x0
1673 Software\Policies\Mozilla\Firefox\Permissions\Location\Locked = 0x1 | 0x0
1674 Software\Policies\Mozilla\Firefox\Permissions\Notifications\Allow\1 = "https://example.org"
1675 Software\Policies\Mozilla\Firefox\Permissions\Notifications\Block\1 = "https://example.edu"
1676 Software\Policies\Mozilla\Firefox\Permissions\Notifications\BlockNewRequests = 0x1 | 0x0
1677 Software\Policies\Mozilla\Firefox\Permissions\Notifications\Locked = 0x1 | 0x0
1678 ```
1679 #### macOS
1680 ```
1681 <dict>
1682 <key>Permissions</key>
1683 <dict>
1684 <key>Camera</key>
1685 <dict>
1686 <key>Allow</key>
1687 <array>
1688 <string>https://example.org</string>
1689 </array>
1690 <key>Block</key>
1691 <array>
1692 <string>https://example.edu</string>
1693 </array>
1694 <key>BlockNewRequests</key>
1695 <true/>
1696 <key>Locked</key>
1697 <true/>
1698 </dict>
1699 <key>Microphone</key>
1700 <dict>
1701 <key>Allow</key>
1702 <array>
1703 <string>https://example.org</string>
1704 </array>
1705 <key>Block</key>
1706 <array>
1707 <string>https://example.edu</string>
1708 </array>
1709 <key>BlockNewRequests</key>
1710 <true/>
1711 <key>Locked</key>
1712 <true/>
1713 </dict>
1714 <key>Location</key>
1715 <dict>
1716 <key>Allow</key>
1717 <array>
1718 <string>https://example.org</string>
1719 </array>
1720 <key>Block</key>
1721 <array>
1722 <string>https://example.edu</string>
1723 </array>
1724 <key>BlockNewRequests</key>
1725 <true/>
1726 <key>Locked</key>
1727 <true/>
1728 </dict>
1729 <key>Notifications</key>
1730 <dict>
1731 <key>Allow</key>
1732 <array>
1733 <string>https://example.org</string>
1734 </array>
1735 <key>Block</key>
1736 <array>
1737 <string>https://example.edu</string>
1738 </array>
1739 <key>BlockNewRequests</key>
1740 <true/>
1741 <key>Locked</key>
1742 <true/>
1743 </dict>
1744 </dict>
1745 </dict>
1746 ```
1747 #### JSON
1748 ```
1749 {
1750 "policies": {
1751 "Permissions": {
1752 "Camera": {
1753 "Allow": ["https://example.org"],
1754 "Block": ["https://example.edu"],
1755 "BlockNewRequests": true | false,
1756 "Locked": true | false
1757 },
1758 "Microphone": {
1759 "Allow": ["https://example.org"],
1760 "Block": ["https://example.edu"],
1761 "BlockNewRequests": true | false,
1762 "Locked": true | false
1763 },
1764 "Location": {
1765 "Allow": ["https://example.org"],
1766 "Block": ["https://example.edu"],
1767 "BlockNewRequests": true | false,
1768 "Locked": true | false
1769 },
1770 "Notifications": {
1771 "Allow": ["https://example.org"],
1772 "Block": ["https://example.edu"],
1773 "BlockNewRequests": true | false,
1774 "Locked": true | false
1775 }
1776 }
1777 }
1778 }
1779 ```
1780 ### PopupBlocking
1781 Configure the default pop-up window policy as well as origins for which pop-up windows are allowed.
1782
1783 `Allow` is a list of origins where popup-windows are allowed.
1784
1785 `Default` determines whether or not pop-up windows are allowed by default.
1786
1787 `Locked` prevents the user from changing pop-up preferences.
1788
1789 **Compatibility:** Firefox 60, Firefox ESR 60\
1790 **CCK2 Equivalent:** `permissions.popup`\
1791 **Preferences Affected:** `dom.disable_open_during_load`
1792
1793 #### Windows
1794 ```
1795 Software\Policies\Mozilla\Firefox\PopupBlocking\Allow\1 = "https://example.org"
1796 Software\Policies\Mozilla\Firefox\PopupBlocking\Allow\2 = "https://example.edu"
1797 Software\Policies\Mozilla\Firefox\PopupBlocking\Default = 0x1 | 0x0
1798 Software\Policies\Mozilla\Firefox\PopupBlocking\Locked = 0x1 | 0x0
1799 ```
1800 #### macOS
1801 ```
1802 <dict>
1803 <key>PopupBlocking</key>
1804 <dict>
1805 <key>Allow</key>
1806 <array>
1807 <string>http://example.org</string>
1808 <string>http://example.edu</string>
1809 </array>
1810 <key>Default</key>
1811 <true/> | <false/>
1812 <key>Locked</key>
1813 <true/> | <false/>
1814 </dict>
1815 </dict>
1816 ```
1817 #### JSON
1818 ```
1819 {
1820 "policies": {
1821 "PopupBlocking": {
1822 "Allow": ["http://example.org/",
1823 "http://example.edu/"],
1824 "Default": true | false,
1825 "Locked": true | false
1826 }
1827 }
1828 }
1829 ```
1830 ### Preferences
1831 Set and lock certain preferences.
1832
1833 **Compatibility:** See below\
1834 **CCK2 Equivalent:** `preferences`\
1835 **Preferences Affected:** See below
1836
1837 | Preference | Type | Compatibility
1838 | --- | --- | ---
1839 | app.update.auto | boolean | Firefox 68, Firefox 68 ESR
1840 | browser.cache.disk.enable | boolean | Firefox 68, Firefox 68 ESR
1841 | browser.cache.disk.parent_directory | string | Firefox 68, Firefox 68 ESR
1842 | browser.fixup.dns_first_for_single_words | boolean | Firefox 68, Firefox 68 ESR
1843 | browser.search.update | boolean | Firefox 68, Firefox 68 ESR
1844 | browser.tabs.warnOnClose | boolean | Firefox 68, Firefox 68 ESR
1845 | browser.urlbar.suggest.bookmark | boolean | Firefox 68, Firefox 68 ESR
1846 | browser.urlbar.suggest.history | boolean | Firefox 68, Firefox 68 ESR
1847 | browser.urlbar.suggest.openpage | boolean | Firefox 68, Firefox 68 ESR
1848 | datareporting.policy.dataSubmissionPolicyBypassNotification | boolean | Firefox 68, Firefox 68 ESR
1849 | dom.disable_window_flip | boolean | Firefox 68, Firefox 68 ESR
1850 | dom.disable_window_move_resize | boolean | Firefox 68, Firefox 68 ESR
1851 | dom.event.contextmenu.enabled | boolean | Firefox 68, Firefox 68 ESR
1852 | dom.keyboardevent.keypress.hack.dispatch_non_printable_keys.addl | string | Firefox 68, Firefox 68 ESR
1853 | dom.keyboardevent.keypress.hack.use_legacy_keycode_and_charcode.addl | string | Firefox 68, Firefox 68 ESR
1854 | extensions.getAddons.showPane | boolean | Firefox 68, Firefox 68 ESR
1855 | media.gmp-gmpopenh264.enabled | boolean | Firefox 68, Firefox 68 ESR
1856 | media.gmp-widevinecdm.enabled | boolean | Firefox 68, Firefox 68 ESR
1857 | network.dns.disableIPv6 | boolean | Firefox 68, Firefox 68 ESR
1858 | network.IDN_show_punycode | boolean | Firefox 68, Firefox 68 ESR
1859 | places.history.enabled | boolean | Firefox 68, Firefox 68 ESR
1860 | security.default_personal_cert | string | Firefox 68, Firefox 68 ESR
1861 | security.ssl.errorReporting.enabled | boolean | Firefox 68, Firefox 68 ESR
1862 | ui.key.menuAccessKeyFocuses | boolean | Firefox 68, Firefox 68 ESR
1863 #### Windows
1864 ```
1865 Software\Policies\Mozilla\Firefox\Preferences\boolean_preference_name = 0x1 | 0x0
1866 Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_value"
1867 ```
1868 #### macOS
1869 ```
1870 <dict>
1871 <key>Preference</key>
1872 <dict>
1873 <key>boolean_preference_name</key>
1874 <true/> | <false/>
1875 <key>string_preference_name</key>
1876 <string>string_value</string>
1877 </dict>
1878 </dict>
1879 ```
1880 #### JSON
1881 ```
1882 {
1883 "policies": {
1884 "Preference": {
1885 "boolean_preference_name": true | false,
1886 "string_preference_name": "string_value"
1887 }
1888 }
1889 }
1890 ```
1891 ### Proxy
1892 Configure proxy settings. These settings correspond to the connection settings in Firefox preferences.
1893 To specify ports, append them to the hostnames with a colon (:).
1894
1895 `Mode` is the proxy method being used.
1896
1897 `Locked` is whether or not proxy settings can be changed.
1898
1899 `HTTPProxy` is the HTTP proxy server.
1900
1901 `UseHTTPProxyForAllProtocols` is whether or not the HTTP proxy should be used for all other proxies.
1902
1903 `SSLProxy` is the SSL proxy server.
1904
1905 `FTPProxy` is the FTP proxy server.
1906
1907 `SOCKSProxy` is the SOCKS proxy server
1908
1909 `SOCKSVersion` is the SOCKS version (4 or 5)
1910
1911 `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.
1912
1913 `AutoConfigURL` is a URL for proxy configuration (only used if Mode is autoConfig).
1914
1915 `AutoLogin` means do not prompt for authentication if password is saved.
1916
1917 `UseProxyForDNS` to use proxy DNS when using SOCKS v5.
1918
1919 **Compatibility:** Firefoox 60, Firefox ESR 60\
1920 **CCK2 Equivalent:** `networkProxy*`\
1921 **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`
1922
1923 #### Windows
1924 ```
1925 Software\Policies\Mozilla\Firefox\Proxy\Mode = "none", "system", "manual", "autoDetect", "autoConfig"
1926 Software\Policies\Mozilla\Firefox\Proxy\Locked = 0x1 | 0x0
1927 Software\Policies\Mozilla\Firefox\=Proxy\HTTPProxy = https://httpproxy.example.com
1928 Software\Policies\Mozilla\Firefox\Proxy\UseHTTPProxyForAllProtocols = 0x1 | 0x0
1929 Software\Policies\Mozilla\Firefox\Proxy\SSLProxy = https://sslproxy.example.com
1930 Software\Policies\Mozilla\Firefox\Proxy\FTPProxy = https://ftpproxy.example.com
1931 Software\Policies\Mozilla\Firefox\Proxy\SOCKSProxy = https://socksproxy.example.com
1932 Software\Policies\Mozilla\Firefox\Proxy\SOCKSVersion = 0x4 | 0x5
1933 Software\Policies\Mozilla\Firefox\Proxy\Passthrough = <local>
1934 Software\Policies\Mozilla\Firefox\Proxy\AutoConfigURL = URL_TO_AUTOCONFIG
1935 Software\Policies\Mozilla\Firefox\Proxy\AutoLogin = 0x1 | 0x0
1936 Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0
1937 ```
1938 #### macOS
1939 ```
1940 <dict>
1941 <key>Proxy</key>
1942 <dict>
1943 <key>Mode</key>
1944 <string>none | system | manual | autoDetect| autoConfig</string>
1945 <key>Locked</key>
1946 <true> | </false>
1947 <key>HTTPProxy</key>
1948 <string>https://httpproxy.example.com</string>
1949 <key>UseHTTPProxyForAllProtocols</key>
1950 <true> | </false>
1951 <key>SSLProxy</key>
1952 <string>https://sslproxy.example.com</string>
1953 <key>FTPProxy</key>
1954 <string>https://ftpproxy.example.com</string>
1955 <key>SOCKSProxy</key>
1956 <string>https://socksproxy.example.com</string>
1957 <key>SOCKSVersion</key>
1958 <string>4 | 5</string>
1959 <key>Passthrough</key>
1960 <string>&lt;local>&gt;</string>
1961 <key>AutoConfigURL</key>
1962 <string>URL_TO_AUTOCONFIG</string>
1963 <key>AutoLogin</key>
1964 <true> | </false>
1965 <key>UseProxyForDNS</key>
1966 <true> | </false>
1967 </dict>
1968 </dict>
1969 ```
1970 ### JSON
1971 ```
1972 {
1973 "policies": {
1974 "Proxy": {
1975 "Mode": "none", "system", "manual", "autoDetect", "autoConfig",
1976 "Locked": [true, false],
1977 "HTTPProxy": "hostname",
1978 "UseHTTPProxyForAllProtocols": [true, false],
1979 "SSLProxy": "hostname",
1980 "FTPProxy": "hostname",
1981 "SOCKSProxy": "hostname",
1982 "SOCKSVersion": 4 | 5
1983 "Passthrough": "<local>",
1984 "AutoConfigURL": "URL_TO_AUTOCONFIG",
1985 "AutoLogin": [true, false],
1986 "UseProxyForDNS": [true, false]
1987 }
1988 }
1989 }
1990 ```
1991 ### RequestedLocales
1992 Set the the list of requested locales for the application in order of preference. It will cause the corresponding language pack to become active.
1993
1994 **Compatibility:** Firefox 64, Firefox ESR 60.4\
1995 **CCK2 Equivalent:** N/A\
1996 **Preferences Affected:** N/A
1997 #### Windows
1998 ```
1999 Software\Policies\Mozilla\Firefox\RequestedLocales\1 = "de"
2000 Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US"
2001 ```
2002 #### macOS
2003 ```
2004 <dict>
2005 <key>RequestedLocales</key>
2006 <array>
2007 <string>de</string>
2008 <string>en-US</string>
2009 </array>
2010 </dict>
2011 ```
2012 #### JSON
2013 ```
2014 {
2015 "policies": {
2016 "RequestedLocales": ["de", "en-US"]
2017 }
2018 }
2019 ```
2020 ### SanitizeOnShutdown (Selective)
2021 Clear data on shutdown. Choose from Cache, Cookies, Download History, Form & Search History, Browsing History, Active Logins, Site Preferences and Offline Website Data.
2022
2023 **Compatibility:** Firefox 68, Firefox ESR 68\
2024 **CCK2 Equivalent:** N/A\
2025 **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`
2026 #### Windows
2027 ```
2028 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Cache = 0x1 | 0x0
2029 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Cookies = 0x1 | 0x0
2030 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Downloads = 0x1 | 0x0
2031 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\FormData = 0x1 | 0x0
2032 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\History = 0x1 | 0x0
2033 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Sessions = 0x1 | 0x0
2034 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\SiteSettings = 0x1 | 0x0
2035 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\OfflineApps = 0x1 | 0x0
2036 ```
2037 #### macOS
2038 ```
2039 <dict>
2040 <key>SanitizeOnShutdown</key>
2041 <dict>
2042 <key>Cache</key>
2043 <true/> | <false/>
2044 <key>Cookies</key>
2045 <true/> | <false/>
2046 <key>Downloads</key>
2047 <true/> | <false/>
2048 <key>FormData</key>
2049 <true/> | <false/>
2050 <key>History</key>
2051 <true/> | <false/>
2052 <key>Sessions</key>
2053 <true/> | <false/>
2054 <key>SiteSettings</key>
2055 <true/> | <false/>
2056 <key>OfflineApps</key>
2057 <true/> | <false/>
2058 </dict>
2059 </dict>
2060 ```
2061 #### JSON
2062 ```
2063 {
2064 "policies": {
2065 "SanitizeOnShutdown": {
2066 "Cache": true | false,
2067 "Cookies": true | false,
2068 "Downloads": true | false,
2069 "FormData": true | false,
2070 "History": true | false,
2071 "Sessions": true | false,
2072 "SiteSettings": true | false,
2073 "OfflineApps": true | false
2074 }
2075 }
2076 }
2077 ```
2078 ### SanitizeOnShutdown (All)
2079 Clear all data on shutdown, including Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data.
2080
2081 **Compatibility:** Firefox 60, Firefox ESR 60\
2082 **CCK2 Equivalent:** N/A\
2083 **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`
2084 #### Windows
2085 ```
2086 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown = 0x1 | 0x0
2087 ```
2088 #### macOS
2089 ```
2090 <dict>
2091 <key>SanitizeOnShutdown</key>
2092 <true/> | <false/>
2093 </dict>
2094 ```
2095 #### JSON
2096 ```
2097 {
2098 "policies": {
2099 "SanitizeOnShutdown": true | false
2100 }
2101 }
2102 ```
2103 ### SearchBar
2104 Set whether or not search bar is displayed.
2105
2106 **Compatibility:** Firefox 60, Firefox ESR 60\
2107 **CCK2 Equivalent:** `showSearchBar`\
2108 **Preferences Affected:** N/A
2109
2110 #### Windows
2111 ```
2112 Software\Policies\Mozilla\Firefox\SearchBar = "unified" | "separate"
2113 ```
2114 #### macOS
2115 ```
2116 <dict>
2117 <key>SearchBar</key>
2118 <string>unified | separate</string>
2119 </dict>
2120 ```
2121
2122 #### JSON
2123 ```
2124 {
2125 "policies": {
2126 "SearchBar": "unified" | "separate"
2127 }
2128 }
2129 ```
2130
2131
2132
2133
2134
2135 ### SearchEngines (This policy is only available on the ESR.)
2136
2137 ### SearchEngines | Default
2138
2139 Set the default search engine. This policy is only available on the ESR.
2140
2141 **Compatibility:** Firefox ESR 60\
2142 **CCK2 Equivalent:** `defaultSearchEngine`\
2143 **Preferences Affected:** N/A
2144
2145 ### Windows
2146 ```
2147 Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
2148 ```
2149 #### macOS
2150 ```
2151 <dict>
2152 <key>SearchEngines</key>
2153 <dict>
2154 <key>Default</key>
2155 <string>NAME_OF_SEARCH_ENGINE</string>
2156 </dict>
2157 </dict>
2158 ```
2159 ### JSON
2160 ```
2161 {
2162 "policies": {
2163 "SearchEngines": {
2164 "Default": "NAME_OF_SEARCH_ENGINE"
2165 }
2166 }
2167 }
2168 ```
2169 ### SearchEngines | PreventInstalls
2170
2171 Prevent installing search engines from webpages.
2172
2173 **Compatibility:** Firefox ESR 60\
2174 **CCK2 Equivalent:** `disableSearchEngineInstall`\
2175 **Preferences Affected:** N/A
2176
2177 ### Windows
2178 ```
2179 Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
2180 ```
2181 #### macOS
2182 ```
2183 <dict>
2184 <key>SearchEngines</key>
2185 <dict>
2186 <key>PreventInstalls</key>
2187 <true/> | <false/>
2188 </dict>
2189 </dict>
2190 ```
2191 ### JSON
2192 ```
2193 {
2194 "policies": {
2195 "SearchEngines": {
2196 "PreventInstalls": true | false
2197 }
2198 }
2199 }
2200 ```
2201 ### SearchEngines | Remove
2202
2203 Hide built-in search engines. This policy is only available on the ESR.
2204
2205 **Compatibility:** Firefox ESR 60.2\
2206 **CCK2 Equivalent:** `removeDefaultSearchEngines` (removed all built-in engines)\
2207 **Preferences Affected:** N/A
2208
2209 ### Windows
2210 ```
2211 Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
2212 ```
2213 #### macOS
2214 ```
2215 <dict>
2216 <key>SearchEngines</key>
2217 <dict>
2218 <key>Remove</key>
2219 <array>
2220 <string>NAME_OF_SEARCH_ENGINE</string>
2221 </array>
2222 </dict>
2223 </dict>
2224 ```
2225 ### JSON
2226 ```
2227 {
2228 "policies": {
2229 "SearchEngines": {
2230 "Remove": ["NAME_OF_SEARCH_ENGINE"]
2231 }
2232 }
2233 }
2234 ```
2235 ### SearchEngines | Add
2236
2237 Adddd new search engines (up to five). This policy is only available on the ESR. `Name` and `URLTemplate` are required.
2238
2239 `Name` is the name of the search engine.
2240
2241 `URLTemplate` is the search URL with {searchTerms} to substitute for the search term.
2242
2243 `Method` is either GET or POST
2244
2245 `IconURL` is a URL for the icon to use.
2246
2247 `Alias` is a keyword to use for the engine.
2248
2249 `Description` is a description of the search engine.
2250
2251 `SuggestURLTemplate` is a search suggestions URL with {searchTerms} to substitute for the search term.
2252
2253 **Compatibility:** Firefox ESR 60\
2254 **CCK2 Equivalent:** `searchplugins`\
2255 **Preferences Affected:** N/A
2256
2257 #### Windows
2258 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Name = "Example1"
2259 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\URLTemplate = "https://www.example.org/q={searchTerms}"
2260 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Method = "GET" | "POST"
2261 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\IconURL = "https://www.example.org/favicon.ico"
2262 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Alias = "example"
2263 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description = "Example Description"
2264 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "https://www.example.org/suggestions/q={searchTerms}"
2265
2266 #### macOS
2267 ```
2268 <dict>
2269 <key>SearchEngines</key>
2270 <dict>
2271 <key>Add</key>
2272 <array>
2273 <dict>
2274 <key>Name</key>
2275 <string>Example1</string>
2276 <key>URLTemplate</key>
2277 <string>https://www.example.org/q={searchTerms}</string>
2278 <key>Method</key>
2279 <string>GET | POST </string>
2280 <key>IconURL</key>
2281 <string>https://www.example.org/favicon.ico</string>
2282 <key>Alias</key>
2283 <string>example</string>
2284 <key>Description</key>
2285 <string>Example Description</string>
2286 <key>SuggestURLTemplate</key>
2287 <string>https://www.example.org/suggestions/q={searchTerms}</string>
2288 </dict>
2289 <array>
2290 </dict>
2291 </dict>
2292 ```
2293 ### JSON
2294 ```
2295 {
2296 "policies": {
2297 "SearchEngines": {
2298 "Add": [
2299 {
2300 "Name": "Example1",
2301 "URLTemplate": "https://www.example.org/q={searchTerms}",
2302 "Method": "GET" | "POST",
2303 "IconURL": "https://www.example.org/favicon.ico",
2304 "Alias": "example",
2305 "Description": "Description",
2306 "SuggestURLTemplate": "https://www.example.org/suggestions/q={searchTerms}"
2307 }
2308 ]
2309 }
2310 }
2311 }
2312 ```
2313 ### SearchSuggestEnabled
2314
2315 Enable search suggestions.
2316
2317 **Compatibility:** Firefox 68, Firefox ESR 68\
2318 **CCK2 Equivalent:** N/A\
2319 **Preferences Affected:** `browser.urlbar.suggest.searches`,`browser.search.suggest.enabled`
2320
2321 ### Windows
2322 ```
2323 Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
2324 ```
2325 #### macOS
2326 ```
2327 <dict>
2328 <key>SearchSuggestEnabled</key>
2329 <true/> | <false/>
2330 </dict>
2331 ```
2332 ### JSON
2333 ```
2334 {
2335 "policies": {
2336 "SearchSuggestEnabled": true | false
2337 }
2338 }
2339 ```
2340 ### SecurityDevices
2341
2342 Install PKCS #11 modules.
2343
2344 **Compatibility:** Firefox 64, Firefox ESR 60.4\
2345 **CCK2 Equivalent:** `certs.devices`\
2346 **Preferences Affected:** N/A
2347
2348 #### Windows
2349 ```
2350 Software\Policies\Mozilla\Firefox\SecurityDevices\NAME_OF_DEVICE = PATH_TO_LIBRARY_FOR_DEVICE
2351 ```
2352 #### macOS
2353 ```
2354 <dict>
2355 <key>SecurityDevices</key>
2356 <dict>
2357 <key>NAME_OF_DEVICE</key>
2358 <string>PATH_TO_LIBRARY_FOR_DEVICE</string>
2359 </dict>
2360 </dict>
2361 ```
2362
2363 #### JSON
2364 ```
2365 {
2366 "policies": {
2367 "SecurityDevices": {
2368 "NAME_OF_DEVICE": "PATH_TO_LIBRARY_FOR_DEVICE"
2369 }
2370 }
2371 }
2372 ```
2373 ### SSLVersionMax
2374
2375 Set and lock the maximum version of TLS.
2376
2377 **Compatibility:** Firefox 66, Firefox ESR 60.6\
2378 **CCK2 Equivalent:** N/A\
2379 **Preferences Affected:** `security.tls.version.max`
2380
2381 #### Windows
2382 ```
2383 Software\Policies\Mozilla\Firefox\SSLVersionMax = "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2384 ```
2385 #### macOS
2386 ```
2387 <dict>
2388 <key>SSLVersionMax</key>
2389 <string>tls1 | tls1.1 | tls1.2 | tls1.3</string>
2390 </dict>
2391 ```
2392
2393 #### JSON
2394 ```
2395 {
2396 "policies": {
2397 "SSLVersionMax": "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2398 }
2399 }
2400 ```
2401 ### SSLVersionMin
2402
2403 Set and lock the minimum version of TLS.
2404
2405 **Compatibility:** Firefox 66, Firefox ESR 60.6\
2406 **CCK2 Equivalent:** N/A\
2407 **Preferences Affected:** `security.tls.version.min`
2408
2409 #### Windows
2410 ```
2411 Software\Policies\Mozilla\Firefox\SSLVersionMin = "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2412 ```
2413 #### macOS
2414 ```
2415 <dict>
2416 <key>SSLVersionMin</key>
2417 <string>tls1 | tls1.1 | tls1.2 | tls1.3</string>
2418 </dict>
2419 ```
2420
2421 #### JSON
2422 ```
2423 {
2424 "policies": {
2425 "SSLVersionMin": "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2426 }
2427 }
2428 ```
2429 ### WebsiteFilter
2430 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.
2431
2432 **Compatibility:** Firefox 60, Firefox ESR 60\
2433 **CCK2 Equivalent:** N/A\
2434 **Preferences Affected:** N/A
2435
2436 #### Windows
2437 ```
2438 Software\Policies\Mozilla\Firefox\WebsiteFilters\Block\1 = "<all_urls>"
2439 Software\Policies\Mozilla\Firefox\WebsiteFilters\Exceptions\1 = "http://example.org/*"
2440 ```
2441 #### macOS
2442 ```
2443 <dict>
2444 <key>WebsiteFilter</key>
2445 <dict>
2446 <key>Block</key>
2447 <array>
2448 <string><all_urls></string>
2449 </array>
2450 <key>Exceptions</key>
2451 <array>
2452 <string>http://example.org/*</string>
2453 </array>
2454 </dict>
2455
2456 </dict>
2457 ```
2458 ### JSON
2459 ```
2460 {
2461 "policies": {
2462 "WebsiteFilter": {
2463 "Block": ["<all_urls>"],
2464 "Exceptions": ["http://example.org/*"]
2465 }
2466 }
2467 }
2468 ```

patrick-canterino.de