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

patrick-canterino.de