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

patrick-canterino.de