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

patrick-canterino.de