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

patrick-canterino.de