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

patrick-canterino.de