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

patrick-canterino.de