]> git.p6c8.net - policy-templates.git/blob - README.md
Merge branch 'master' of github.com:mozilla/policy-templates
[policy-templates.git] / README.md
1 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.
2
3 | Policy Name | Description
4 | --- | --- |
5 | **[`AppUpdateURL`](#AppUpdateURL)** | Change the URL for application update.
6 | **[`Authentication`](#Authentication)** | Configure sites that support integrated authentication.
7 | **[`BlockAboutAddons`](#blockaboutaddons)** | Block access to the Add-ons Manager (about:addons).
8 | **[`BlockAboutConfig`](#blockaboutconfig)** | Block access to about:config.
9 | **[`BlockAboutProfiles`](#blockaboutprofiles)** | Block access to About Profiles (about:profiles).
10 | **[`BlockAboutSupport`](#blockaboutsupport)** | Block access to Troubleshooting Information (about:support).
11 | **[`Bookmarks`](#bookmarks)** | Add bookmarks in either the bookmarks toolbar or menu.
12 | **[`CaptivePortal`](#captiveportal)** | Enable or disable the detection of captive portals.
13 | **[`Certificates`](#certificates)** |
14 | **[`Certificates -> ImportEnterpriseRoots`](#certificates--importenterpriseroots)** | Trust certificates that have been added to the operating system certificate store by a user or administrator.
15 | **[`Certificates -> Install`](#certificates--install)** | Install certificates into the Firefox certificate store.
16 | **[`Cookies`](#cookies)** | Configure cookie preferences.
17 | **[`DisableSetDesktopBackground`](#disablesetdesktopbackground)** | Remove the "Set As Desktop Background..." menuitem when right clicking on an image.
18 | **[`DisableMasterPasswordCreation`](#disablemasterpasswordcreation)** | Remove the master password functionality.
19 | **[`DisableAppUpdate`](#disableappupdate)** | Turn off application updates.
20 | **[`DisableBuiltinPDFViewer`](#disablebuiltinpdfviewer)** | Disable the built in PDF viewer.
21 | **[`DisableDeveloperTools`](#disabledevelopertools)** | Remove access to all developer tools.
22 | **[`DisableFeedbackCommands`](#disablefeedbackcommands)** | Disable the menus for reporting sites.
23 | **[`DisableFirefoxScreenshots`](#disablefirefoxscreenshots)** | Remove access to Firefox Screenshots.
24 | **[`DisableFirefoxAccounts`](#disablefirefoxaccounts)** | Disable Firefox Accounts integration (Sync).
25 | **[`DisableFirefoxStudies`](#disablefirefoxstudies)** | Disable Firefox studies (Shield).
26 | **[`DisableForgetButton`](#disableforgetbutton)** | Disable the "Forget" button.
27 | **[`DisableFormHistory`](#disableformhistory)** | Turn off saving information on web forms and the search bar.
28 | **[`DisablePocket`](#disablepocket)** | Remove Pocket in the Firefox UI.
29 | **[`DisablePrivateBrowsing`](#disableprivatebrowsing)** | Remove access to private browsing.
30 | **[`DisableProfileImport`](#disableprofileimport)** | Disables the "Import data from another browser" option in the bookmarks window.
31 | **[`DisableProfileRefresh`](#disableprofilerefresh)** | Disable the Refresh Firefox button on about:support and support.mozilla.org
32 | **[`DisableSafeMode`](#disablesafemode)** | Disable safe mode within the browser.
33 | **[`DisableSecurityBypass`](#disablesecuritybypass)** | Prevent the user from bypassing security in certain cases.
34 | **[`DisableSystemAddonUpdate`](#disablesystemaddonupdate)** | Prevent system add-ons from being installed or update.
35 | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry
36 | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar.
37 | **[`DisplayMenuBar`](#displaymenubar)** | Set the initial state of the menubar.
38 | **[`DNSOverHTTPS`](#dnsoverhttps)** | Configure DNS over HTTPS.
39 | **[`DontCheckDefaultBrowser`](#dontcheckdefaultbrowser)** | Don't check if Firefox is the default browser at startup.
40 | **[`DefaultDownloadDirectory`](#defaultdownloaddirectory)** | Set the default download directory.
41 | **[`DownloadDirectory`](#downloaddirectory)** | Set and lock the download directory.
42 | **[`EnableTrackingProtection`](#enabletrackingprotection)** | Configure tracking protection.
43 | **[`EnterprisePoliciesEnabled`](#enterprisepoliciesenabled)** | Enable policy support on macOS.
44 | **[`Extensions`](#extensions)** | Control the installation, uninstallation and locking of extensions.
45 | **[`ExtensionUpdate`](#extensionupdate)** | Control extension updates.
46 | **[`FlashPlugin`](#flashplugin)** | Configure the default Flash plugin policy as well as origins for which Flash is allowed.
47 | **[`FirefoxHome`](#firefoxhome)** | Customize the Firefox Home page.
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 | **[`SupportMenu`](#supportmenu)** | Add a menuitem to the help menu for specifying support information.
77 | **[`WebsiteFilter`](#websitefilter)** | Block websites from being visited.
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\DNSOverHTTPS\Enabled = 0x1 | 0x0
1105 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\ProviderURL = "URL_TO_ALTERNATE_PROVIDER"
1106 Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Locked = 0x1 | 0x0
1107 ```
1108 #### macOS
1109 ```
1110 <dict>
1111 <key>DNSOverHTTPS</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 (macOS and Linux)
1181 ```
1182 {
1183 "policies": {
1184 "DefaultDownloadDirectory": "${home}/Downloads"
1185 }
1186 ```
1187 #### JSON (Windows)
1188 ```
1189 {
1190 "policies": {
1191 "DefaultDownloadDirectory": "${home}\\Downloads"
1192 }
1193 ```
1194 ### DownloadDirectory
1195 Set and lock the download directory.
1196
1197 You can use ${home} for the native home directory.
1198
1199 **Compatibility:** Firefox 68, Firefox ESR 68\
1200 **CCK2 Equivalent:** N/A\
1201 **Preferences Affected:** `browser.download.dir`,`browser.download.folderList`,`browser.download.useDownloadDir`
1202
1203 #### Windows
1204 ```
1205 Software\Policies\Mozilla\Firefox\DownloadDirectory = "${home}\Downloads"
1206 ```
1207 #### macOS
1208 ```
1209 <dict>
1210 <key>DownloadDirectory</key>
1211 <string>${home}/Downloads</string>
1212 </dict>
1213 ```
1214 #### JSON (macOS and Linux)
1215 ```
1216 {
1217 "policies": {
1218 "DownloadDirectory": "${home}/Downloads"
1219 }
1220 ```
1221 #### JSON (Windows)
1222 ```
1223 {
1224 "policies": {
1225 "DownloadDirectory": "${home}\\Downloads"
1226 }
1227 ```
1228 ### EnableTrackingProtection
1229 Configure tracking protection.
1230
1231 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.
1232
1233 If `Value` is set to false, tracking protection is disabled and locked in both the regular browser and private browsing.
1234
1235 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.
1236
1237 **Compatibility:** Firefox 60, Firefox ESR 60\
1238 **CCK2 Equivalent:** `dontCheckDefaultBrowser`\
1239 **Preferences Affected:** `privacy.trackingprotection.enabled`,`privacy.trackingprotection.pbmode.enabled`
1240
1241 #### Windows
1242 ```
1243 Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Value = 0x1 | 0x0
1244 Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Locked = 0x1 | 0x0
1245 ```
1246 #### macOS
1247 ```
1248 <dict>
1249 <key>EnableTrackingProtection</key>
1250 <dict>
1251 <key>Value</key>
1252 <true/> | <false/>
1253
1254 <key><Locked/key>
1255 <true/> | <false/>
1256 </dict>
1257 </dict>
1258 ```
1259 #### JSON
1260 ```
1261 {
1262 "policies": {
1263 "EnableTrackingProtection": {
1264 "Value": [true, false],
1265 "Locked": [true, false]
1266 }
1267 }
1268 ```
1269 ### EnterprisePoliciesEnabled
1270 Enable policy support on macOS.
1271
1272 **Compatibility:** Firefox 63, Firefox ESR 60.3 (macOS only)\
1273 **CCK2 Equivalent:** N/A\
1274 **Preferences Affected:** N/A
1275
1276 #### macOS
1277 ```
1278 <dict>
1279 <key>EnterprisePoliciesEnabled</key>
1280 <true/>
1281 </dict>
1282 ```
1283 ### Extensions
1284 Control the installation, uninstallation and locking of extensions.
1285
1286 `Install` is a list of URLs or native paths for extensions to be installed.
1287
1288 `Uninstall` is a list of extension IDs that should be uninstalled if found.
1289
1290 `Locked` is a list of extension IDs that the user cannot disable or uninstall.
1291
1292 **Compatibility:** Firefox 60, Firefox ESR 60\
1293 **CCK2 Equivalent:** `addons`\
1294 **Preferences Affected:** N/A
1295
1296 #### Windows
1297 ```
1298 Software\Policies\Mozilla\Firefox\Extensions\Install\1 = "https://addons.mozilla.org/firefox/downloads/somefile.xpi"
1299 Software\Policies\Mozilla\Firefox\Extensions\Install\2 = "//path/to/xpi"
1300 Software\Policies\Mozilla\Firefox\Extensions\Uninstall\1 = "bad_addon_id@mozilla.org"
1301 Software\Policies\Mozilla\Firefox\Extensions\Locked\1 = "addon_id@mozilla.org"
1302 ```
1303 #### macOS
1304 ```
1305 <dict>
1306 <key>Extensions</key>
1307 <dict>
1308 <key>Install</key>
1309 <array>
1310 <string>https://addons.mozilla.org/firefox/downloads/somefile.xpi</string>
1311 <string>//path/to/xpi</string>
1312 </array>
1313 <key>Uninstall</key>
1314 <array>
1315 <string>bad_addon_id@mozilla.org</string>
1316 </array>
1317 <key>Locked</key>
1318 <array>
1319 <string>addon_id@mozilla.org</string>
1320 </array>
1321 </dict>
1322 </dict>
1323 ```
1324 #### JSON
1325
1326
1327 ```
1328 {
1329 "policies": {
1330 "Extensions": {
1331 "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"],
1332 "Uninstall": ["bad_addon_id@mozilla.org"],
1333 "Locked": ["addon_id@mozilla.org"]
1334 }
1335 }
1336 }
1337 ```
1338 ### ExtensionSettings
1339 Do NOT use this policy. You risk uninstalling your search extensions.
1340
1341 ### ExtensionUpdate
1342 Control extension updates.
1343
1344 **Compatibility:** Firefox 67, Firefox ESR 60.7\
1345 **CCK2 Equivalent:** N/A\
1346 **Preferences Affected:** `extensions.update.enabled`
1347
1348 #### Windows
1349 ```
1350 Software\Policies\Mozilla\Firefox\ExtensionUpdate = 0x1 | 0x0
1351 ```
1352 #### macOS
1353 ```
1354 <dict>
1355 <key>ExtensionUpdate</key>
1356 <true/> | <false/>
1357 </dict>
1358 ```
1359 #### JSON
1360 ```
1361 {
1362 "policies": {
1363 "ExtensionUpdate": true | false
1364 }
1365 }
1366 ```
1367 ### FlashPlugin
1368 Configure the default Flash plugin policy as well as origins for which Flash is allowed.
1369
1370 `Allow` is a list of origins where Flash are allowed.
1371
1372 `Block` is a list of origins where Flash is not allowed.
1373
1374 `Default` determines whether or not Flash is allowed by default.
1375
1376 `Locked` prevents the user from changing Flash preferences.
1377
1378 **Compatibility:** Firefox 60, Firefox ESR 60\
1379 **CCK2 Equivalent:** `permissions.plugin`\
1380 **Preferences Affected:** `plugin.state.flash`
1381
1382 #### Windows
1383 ```
1384 Software\Policies\Mozilla\Firefox\FlashPlugin\Allow\1 = "https://example.org"
1385 Software\Policies\Mozilla\Firefox\FlashPlugin\Block\1 = "https://example.edu"
1386 Software\Policies\Mozilla\Firefox\FlashPlugin\Default = 0x1 | 0x0
1387 Software\Policies\Mozilla\Firefox\FlashPlugin\Locked = 0x1 | 0x0
1388 ```
1389 #### macOS
1390 ```
1391 <dict>
1392 <key>FlashPlugin</key>
1393 <dict>
1394 <key>Allow</key>
1395 <array>
1396 <string>http://example.org</string>
1397 </array>
1398 <key>Block</key>
1399 <array>
1400 <string>http://example.edu</string>
1401 </array>
1402 <key>Default</key>
1403 <true/> | <false/>
1404 <key>Locked</key>
1405 <true/> | <false/>
1406 </dict>
1407 </dict>
1408 ```
1409 #### JSON
1410 ```
1411 {
1412 "policies": {
1413 "FlashPlugin": {
1414 "Allow": ["http://example.org/"],
1415 "Block": ["http://example.edu/"],
1416 "Default": true | false,
1417 "Locked": true | false
1418 }
1419 }
1420 }
1421 ```
1422 ### FirefoxHome
1423 Customize the Firefox Home page.
1424
1425 **Compatibility:** Firefox 68, Firefox ESR 68\
1426 **CCK2 Equivalent:** N/A\
1427 **Preferences Affected:** `browser.newtabpage.activity-stream.showSearch`,`browser.newtabpage.activity-stream.feeds.topsites`,`browser.newtabpage.activity-stream.feeds.section.highlights`,`browser.newtabpage.activity-stream.feeds.section.topstories`,`browser.newtabpage.activity-stream.feeds.snippets`
1428
1429 #### Windows
1430 ```
1431 Software\Policies\Mozilla\Firefox\FirefoxHome\Search = 0x1 | 0x0
1432 Software\Policies\Mozilla\Firefox\FirefoxHome\TopSites = 0x1 | 0x0
1433 Software\Policies\Mozilla\Firefox\FirefoxHome\Highlights = 0x1 | 0x0
1434 Software\Policies\Mozilla\Firefox\FirefoxHome\Pocket = 0x1 | 0x0
1435 Software\Policies\Mozilla\Firefox\FirefoxHome\Snippets = 0x1 | 0x0
1436 Software\Policies\Mozilla\Firefox\FirefoxHome\Locked = 0x1 | 0x0
1437 ```
1438 #### macOS
1439 ```
1440 <dict>
1441 <key>FirefoxHome</key>
1442 <dict>
1443 <key>Search</key>
1444 <true/> | <false/>
1445 <key>TopSites</key>
1446 <true/> | <false/>
1447 <key>Highlights</key>
1448 <true/> | <false/>
1449 <key>Pocket</key>
1450 <true/> | <false/>
1451 <key>Snippets</key>
1452 <true/> | <false/>
1453 <key>Locked</key>
1454 <true/> | <false/>
1455 </dict>
1456 </dict>
1457 ```
1458 #### JSON
1459 ```
1460 {
1461 "policies": {
1462 "FirefoxHome": {
1463 "Search": true | false,
1464 "TopSites": true | false,
1465 "Highlights": true | false,
1466 "Pocket": true | false,
1467 "Snippets": true | false,
1468 "Locked": true | false
1469 }
1470 }
1471 }
1472 ```
1473 ### HardwareAcceleration
1474 Control hardware acceleration.
1475
1476 **Compatibility:** Firefox 60, Firefox ESR 60\
1477 **CCK2 Equivalent:** N/A\
1478 **Preferences Affected:** `layers.acceleration.disabled`
1479
1480 #### Windows
1481 ```
1482 Software\Policies\Mozilla\Firefox\HardwareAcceleration = 0x1 | 0x0
1483 ```
1484 #### macOS
1485 ```
1486 <dict>
1487 <key>HardwareAcceleration</key>
1488 <true/> | <false/>
1489 </dict>
1490 ```
1491 #### JSON
1492 ```
1493 {
1494 "policies": {
1495 "HardwareAcceleration": true | false
1496 }
1497 }
1498 ```
1499 ### Homepage
1500 Configure the default homepage and how Firefox starts.
1501
1502 `URL` is the default homepage.
1503
1504 `Locked` prevents the user from changing homepage preferences.
1505
1506 `Additional` allows for more than one homepage.
1507
1508 `StartPage` is how Firefox starts. The choices are no homepage, the default homepage or the previous session.
1509
1510 **Compatibility:** Firefox 60, Firefox ESR 60 (StartPage was added in Firefox 60, Firefox ESR 60.4)\
1511 **CCK2 Equivalent:** `homePage`,`lockHomePage`\
1512 **Preferences Affected:** `browser.startup.homepage`,`browser.startup.page`
1513
1514 #### Windows
1515 ```
1516 Software\Policies\Mozilla\Firefox\Homepage\URL = "https://example.com"
1517 Software\Policies\Mozilla\Firefox\Homepage\Locked = 0x1 | 0x0
1518 Software\Policies\Mozilla\Firefox\Homepage\Additional\1 = "https://example.org"
1519 Software\Policies\Mozilla\Firefox\Homepage\Additional\2 = "https://example.edu"
1520 Software\Policies\Mozilla\Firefox\Homepage\StartPage = "none" | "homepage" | "previous-session"
1521 ```
1522 #### macOS
1523 ```
1524 <dict>
1525 <key>Homepage</key>
1526 <dict>
1527 <key>URL</key>
1528 <string>http://example.com</string>
1529 <key>Locked</key>
1530 <true/> | <false/>
1531 <key>Additional</key>
1532 <array>
1533 <string>http://example.org</string>
1534 <string>http://example.edu</string>
1535 </array>
1536 <key>StartPage</key>
1537 <string>always | never | from-visited</string>
1538 </dict>
1539 </dict>
1540 ```
1541 #### JSON
1542 ```
1543 {
1544 "policies": {
1545 "Homepage": {
1546 "URL": "http://example.com/",
1547 "Locked": true | false,
1548 "Additional": ["http://example.org/",
1549 "http://example.edu/"],
1550 "StartPage": "none" | "homepage" | "previous-session"
1551 }
1552 }
1553 }
1554 ```
1555 ### InstallAddonsPermission
1556 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.
1557
1558 `Allow` is a list of origins where extension installs are allowed.
1559
1560 `Default` determines whether or not extension installs are allowed by default.
1561
1562 **Compatibility:** Firefox 60, Firefox ESR 60\
1563 **CCK2 Equivalent:** `permissions.install`\
1564 **Preferences Affected:** `xpinstall.enabled`
1565
1566 #### Windows
1567 ```
1568 Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Allow\1 = "https://example.org"
1569 Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Allow\2 = "https://example.edu"
1570 Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Default = 0x1 | 0x0
1571 ```
1572 #### macOS
1573 ```
1574 <dict>
1575 <key>InstallAddonsPermission</key>
1576 <dict>
1577 <key>Allow</key>
1578 <array>
1579 <string>http://example.org</string>
1580 <string>http://example.edu</string>
1581 </array>
1582 <key>Default</key>
1583 <true/> | <false/>
1584 </dict>
1585 </dict>
1586 ```
1587 #### JSON
1588 ```
1589 {
1590 "policies": {
1591 "InstallAddonsPermission": {
1592 "Allow": ["http://example.org/",
1593 "http://example.edu/"],
1594 "Default": true | false
1595 }
1596 }
1597 }
1598 ```
1599 ### LocalFileLinks
1600 Enable linking to local files by origin.
1601
1602 **Compatibility:** Firefox 68, Firefox ESR 68\
1603 **CCK2 Equivalent:** N/A\
1604 **Preferences Affected:** `capability.policy.localfilelinks.*`
1605
1606 #### Windows
1607 ```
1608 Software\Policies\Mozilla\Firefox\LocalFileLinks\1 = "https://example.org"
1609 Software\Policies\Mozilla\Firefox\LocalFileLinks\2 = "https://example.edu"
1610 ```
1611 #### macOS
1612 ```
1613 <dict>
1614 <key>LocalFileLinks</key>
1615 <array>
1616 <string>http://example.org</string>
1617 <string>http://example.edu</string>
1618 </array>
1619 </dict>
1620 ```
1621 #### JSON
1622 ```
1623 {
1624 "policies": {
1625 "LocalFileLinks": ["http://example.org/",
1626 "http://example.edu/"]
1627 }
1628 }
1629 ```
1630 ### NoDefaultBookmarks
1631 Disable the creation of default bookmarks.
1632
1633 This policy is only effective if the user profile has not been created yet.
1634
1635 **Compatibility:** Firefox 60, Firefox ESR 60\
1636 **CCK2 Equivalent:** `removeDefaultBookmarks`\
1637 **Preferences Affected:** N/A
1638
1639 #### Windows
1640 ```
1641 Software\Policies\Mozilla\Firefox\NoDefaultBookmarks = 0x1 | 0x0
1642 ```
1643 #### macOS
1644 ```
1645 <dict>
1646 <key>NoDefaultBookmarks</key>
1647 <true/> | <false/>
1648 </dict>
1649 ```
1650 #### JSON
1651 ```
1652 {
1653 "policies": {
1654 "NoDefaultBookmarks": true | false
1655 }
1656 }
1657 ```
1658 ### NetworkPrediction
1659 Enable or disable network prediction (DNS prefetching).
1660
1661 **Compatibility:** Firefox 67, Firefox ESR 60.7\
1662 **CCK2 Equivalent:** N/A\
1663 **Preferences Affected:** `network.dns.disablePrefetch`,`network.dns.disablePrefetchFromHTTPS`
1664
1665 #### Windows
1666 ```
1667 Software\Policies\Mozilla\Firefox\NetworkPrediction = 0x1 | 0x0
1668 ```
1669 #### macOS
1670 ```
1671 <dict>
1672 <key>NetworkPrediction</key>
1673 <true/> | <false/>
1674 </dict>
1675 ```
1676 #### JSON
1677 ```
1678 {
1679 "policies": {
1680 "NetworkPrediction": true | false
1681 }
1682 ```
1683 ### NewTabPage
1684 Enable or disable the New Tab page.
1685
1686 **Compatibility:** Firefox 68, Firefox ESR 68\
1687 **CCK2 Equivalent:** N/A\
1688 **Preferences Affected:** `browser.newtabpage.enabled`
1689
1690 #### Windows
1691 ```
1692 Software\Policies\Mozilla\Firefox\NewTabPage = 0x1 | 0x0
1693 ```
1694 #### macOS
1695 ```
1696 <dict>
1697 <key>NewTabPage</key>
1698 <true/> | <false/>
1699 </dict>
1700 ```
1701 #### JSON
1702 ```
1703 {
1704 "policies": {
1705 "NewTabPage": true | false
1706 }
1707 ```
1708 ### OfferToSaveLogins
1709 Control whether or not Firefox offers to save passwords.
1710
1711 **Compatibility:** Firefox 60, Firefox ESR 60\
1712 **CCK2 Equivalent:** `dontRememberPasswords`\
1713 **Preferences Affected:** `signon.rememberSignons`
1714
1715 #### Windows
1716 ```
1717 Software\Policies\Mozilla\Firefox\OfferToSaveLogins = 0x1 | 0x0
1718 ```
1719 #### macOS
1720 ```
1721 <dict>
1722 <key>OfferToSaveLogins</key>
1723 <true/> | <false/>
1724 </dict>
1725 ```
1726 #### JSON
1727 ```
1728 {
1729 "policies": {
1730 "OfferToSaveLogins": true | false
1731 }
1732 }
1733 ```
1734 ### OverrideFirstRunPage
1735 Override the first run page. If the value is blank, no first run page is displayed.
1736
1737 **Compatibility:** Firefox 60, Firefox ESR 60\
1738 **CCK2 Equivalent:** `welcomePage`,`noWelcomePage`\
1739 **Preferences Affected:** `startup.homepage_welcome_url`
1740
1741 #### Windows
1742 ```
1743 Software\Policies\Mozilla\Firefox\OverrideFirstRunPage = "http://example.org"
1744 ```
1745 #### macOS
1746 ```
1747 <dict>
1748 <key>OverrideFirstRunPage</key>
1749 <string>http://example.org</string>
1750 </dict>
1751 ```
1752 #### JSON
1753 ```
1754 {
1755 "policies": {
1756 "OverrideFirstRunPage": "http://example.org"
1757 }
1758 ```
1759 ### OverridePostUpdatePage
1760 Override the upgrade page. If the value is blank, no upgrade page is displayed.
1761
1762 **Compatibility:** Firefox 60, Firefox ESR 60\
1763 **CCK2 Equivalent:** `upgradePage`,`noUpgradePage`\
1764 **Preferences Affected:** `startup.homepage_override_url`
1765
1766 #### Windows
1767 ```
1768 Software\Policies\Mozilla\Firefox\OverridePostUpdatePage = "http://example.org"
1769 ```
1770 #### macOS
1771 ```
1772 <dict>
1773 <key>OverridePostUpdatePage</key>
1774 <string>http://example.org</string>
1775 </dict>
1776 ```
1777 #### JSON
1778 ```
1779 {
1780 "policies": {
1781 "OverridePostUpdatePage": "http://example.org"
1782 }
1783 ```
1784 ### Permissions
1785 Set permissions associated with camera, microphone, location, and notifications
1786
1787 `Allow` is a list of origins where the feature is allowed.
1788
1789 `Block` is a list of origins where the feature is not allowed.
1790
1791 `BlockNewRequests` determines whether or not new requests can be made for the feature.
1792
1793 `Locked` prevents the user from changing preferences for the feature.
1794
1795 **Compatibility:** Firefox 62, Firefox ESR 60.2\
1796 **CCK2 Equivalent:** N/A\
1797 **Preferences Affected:** `permissions.default.camera`,`permissions.default.microphone`,`permissions.default.geo`,`permissions.default.desktop-notification`
1798
1799 #### Windows
1800 ```
1801 Software\Policies\Mozilla\Firefox\Permissions\Camera\Allow\1 = "https://example.org"
1802 Software\Policies\Mozilla\Firefox\Permissions\Camera\Block\1 = "https://example.edu"
1803 Software\Policies\Mozilla\Firefox\Permissions\Camera\BlockNewRequests = 0x1 | 0x0
1804 Software\Policies\Mozilla\Firefox\Permissions\Camera\Locked = 0x1 | 0x0
1805 Software\Policies\Mozilla\Firefox\Permissions\Microphone\Allow\1 = "https://example.org"
1806 Software\Policies\Mozilla\Firefox\Permissions\Microphone\Block\1 = "https://example.edu"
1807 Software\Policies\Mozilla\Firefox\Permissions\Microphone\BlockNewRequests = 0x1 | 0x0
1808 Software\Policies\Mozilla\Firefox\Permissions\Microphone\Locked = 0x1 | 0x0
1809 Software\Policies\Mozilla\Firefox\Permissions\Location\Allow\1 = "https://example.org"
1810 Software\Policies\Mozilla\Firefox\Permissions\Location\Block\1 = "https://example.edu"
1811 Software\Policies\Mozilla\Firefox\Permissions\Location\BlockNewRequests = 0x1 | 0x0
1812 Software\Policies\Mozilla\Firefox\Permissions\Location\Locked = 0x1 | 0x0
1813 Software\Policies\Mozilla\Firefox\Permissions\Notifications\Allow\1 = "https://example.org"
1814 Software\Policies\Mozilla\Firefox\Permissions\Notifications\Block\1 = "https://example.edu"
1815 Software\Policies\Mozilla\Firefox\Permissions\Notifications\BlockNewRequests = 0x1 | 0x0
1816 Software\Policies\Mozilla\Firefox\Permissions\Notifications\Locked = 0x1 | 0x0
1817 ```
1818 #### macOS
1819 ```
1820 <dict>
1821 <key>Permissions</key>
1822 <dict>
1823 <key>Camera</key>
1824 <dict>
1825 <key>Allow</key>
1826 <array>
1827 <string>https://example.org</string>
1828 </array>
1829 <key>Block</key>
1830 <array>
1831 <string>https://example.edu</string>
1832 </array>
1833 <key>BlockNewRequests</key>
1834 <true/>
1835 <key>Locked</key>
1836 <true/>
1837 </dict>
1838 <key>Microphone</key>
1839 <dict>
1840 <key>Allow</key>
1841 <array>
1842 <string>https://example.org</string>
1843 </array>
1844 <key>Block</key>
1845 <array>
1846 <string>https://example.edu</string>
1847 </array>
1848 <key>BlockNewRequests</key>
1849 <true/>
1850 <key>Locked</key>
1851 <true/>
1852 </dict>
1853 <key>Location</key>
1854 <dict>
1855 <key>Allow</key>
1856 <array>
1857 <string>https://example.org</string>
1858 </array>
1859 <key>Block</key>
1860 <array>
1861 <string>https://example.edu</string>
1862 </array>
1863 <key>BlockNewRequests</key>
1864 <true/>
1865 <key>Locked</key>
1866 <true/>
1867 </dict>
1868 <key>Notifications</key>
1869 <dict>
1870 <key>Allow</key>
1871 <array>
1872 <string>https://example.org</string>
1873 </array>
1874 <key>Block</key>
1875 <array>
1876 <string>https://example.edu</string>
1877 </array>
1878 <key>BlockNewRequests</key>
1879 <true/>
1880 <key>Locked</key>
1881 <true/>
1882 </dict>
1883 </dict>
1884 </dict>
1885 ```
1886 #### JSON
1887 ```
1888 {
1889 "policies": {
1890 "Permissions": {
1891 "Camera": {
1892 "Allow": ["https://example.org"],
1893 "Block": ["https://example.edu"],
1894 "BlockNewRequests": true | false,
1895 "Locked": true | false
1896 },
1897 "Microphone": {
1898 "Allow": ["https://example.org"],
1899 "Block": ["https://example.edu"],
1900 "BlockNewRequests": true | false,
1901 "Locked": true | false
1902 },
1903 "Location": {
1904 "Allow": ["https://example.org"],
1905 "Block": ["https://example.edu"],
1906 "BlockNewRequests": true | false,
1907 "Locked": true | false
1908 },
1909 "Notifications": {
1910 "Allow": ["https://example.org"],
1911 "Block": ["https://example.edu"],
1912 "BlockNewRequests": true | false,
1913 "Locked": true | false
1914 }
1915 }
1916 }
1917 }
1918 ```
1919 ### PopupBlocking
1920 Configure the default pop-up window policy as well as origins for which pop-up windows are allowed.
1921
1922 `Allow` is a list of origins where popup-windows are allowed.
1923
1924 `Default` determines whether or not pop-up windows are allowed by default.
1925
1926 `Locked` prevents the user from changing pop-up preferences.
1927
1928 **Compatibility:** Firefox 60, Firefox ESR 60\
1929 **CCK2 Equivalent:** `permissions.popup`\
1930 **Preferences Affected:** `dom.disable_open_during_load`
1931
1932 #### Windows
1933 ```
1934 Software\Policies\Mozilla\Firefox\PopupBlocking\Allow\1 = "https://example.org"
1935 Software\Policies\Mozilla\Firefox\PopupBlocking\Allow\2 = "https://example.edu"
1936 Software\Policies\Mozilla\Firefox\PopupBlocking\Default = 0x1 | 0x0
1937 Software\Policies\Mozilla\Firefox\PopupBlocking\Locked = 0x1 | 0x0
1938 ```
1939 #### macOS
1940 ```
1941 <dict>
1942 <key>PopupBlocking</key>
1943 <dict>
1944 <key>Allow</key>
1945 <array>
1946 <string>http://example.org</string>
1947 <string>http://example.edu</string>
1948 </array>
1949 <key>Default</key>
1950 <true/> | <false/>
1951 <key>Locked</key>
1952 <true/> | <false/>
1953 </dict>
1954 </dict>
1955 ```
1956 #### JSON
1957 ```
1958 {
1959 "policies": {
1960 "PopupBlocking": {
1961 "Allow": ["http://example.org/",
1962 "http://example.edu/"],
1963 "Default": true | false,
1964 "Locked": true | false
1965 }
1966 }
1967 }
1968 ```
1969 ### Preferences
1970 Set and lock certain preferences.
1971
1972 **Compatibility:** See below\
1973 **CCK2 Equivalent:** `preferences`\
1974 **Preferences Affected:** See below
1975
1976 | Preference | Type | Compatibility
1977 | --- | --- | ---
1978 | app.update.auto | boolean | Firefox 68, Firefox 68 ESR
1979 | browser.cache.disk.enable | boolean | Firefox 68, Firefox 68 ESR
1980 | browser.cache.disk.parent_directory | string | Firefox 68, Firefox 68 ESR
1981 | browser.fixup.dns_first_for_single_words | boolean | Firefox 68, Firefox 68 ESR
1982 | browser.search.update | boolean | Firefox 68, Firefox 68 ESR
1983 | browser.tabs.warnOnClose | boolean | Firefox 68, Firefox 68 ESR
1984 | browser.urlbar.suggest.bookmark | boolean | Firefox 68, Firefox 68 ESR
1985 | browser.urlbar.suggest.history | boolean | Firefox 68, Firefox 68 ESR
1986 | browser.urlbar.suggest.openpage | boolean | Firefox 68, Firefox 68 ESR
1987 | datareporting.policy.dataSubmissionPolicyBypassNotification | boolean | Firefox 68, Firefox 68 ESR
1988 | dom.disable_window_flip | boolean | Firefox 68, Firefox 68 ESR
1989 | dom.disable_window_move_resize | boolean | Firefox 68, Firefox 68 ESR
1990 | dom.event.contextmenu.enabled | boolean | Firefox 68, Firefox 68 ESR
1991 | dom.keyboardevent.keypress.hack.dispatch_non_printable_keys.addl | string | Firefox 68, Firefox 68 ESR
1992 | dom.keyboardevent.keypress.hack.use_legacy_keycode_and_charcode.addl | string | Firefox 68, Firefox 68 ESR
1993 | extensions.getAddons.showPane | boolean | Firefox 68, Firefox 68 ESR
1994 | media.gmp-gmpopenh264.enabled | boolean | Firefox 68, Firefox 68 ESR
1995 | media.gmp-widevinecdm.enabled | boolean | Firefox 68, Firefox 68 ESR
1996 | network.dns.disableIPv6 | boolean | Firefox 68, Firefox 68 ESR
1997 | network.IDN_show_punycode | boolean | Firefox 68, Firefox 68 ESR
1998 | places.history.enabled | boolean | Firefox 68, Firefox 68 ESR
1999 | security.default_personal_cert | string | Firefox 68, Firefox 68 ESR
2000 | security.ssl.errorReporting.enabled | boolean | Firefox 68, Firefox 68 ESR
2001 | ui.key.menuAccessKeyFocuses | boolean | Firefox 68, Firefox 68 ESR
2002 #### Windows
2003 ```
2004 Software\Policies\Mozilla\Firefox\Preferences\boolean_preference_name = 0x1 | 0x0
2005 Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_value"
2006 ```
2007 #### macOS
2008 ```
2009 <dict>
2010 <key>Preferences</key>
2011 <dict>
2012 <key>boolean_preference_name</key>
2013 <true/> | <false/>
2014 <key>string_preference_name</key>
2015 <string>string_value</string>
2016 </dict>
2017 </dict>
2018 ```
2019 #### JSON
2020 ```
2021 {
2022 "policies": {
2023 "Preferences": {
2024 "boolean_preference_name": true | false,
2025 "string_preference_name": "string_value"
2026 }
2027 }
2028 }
2029 ```
2030 ### PromptForDownloadLocation
2031 Ask where to save each file before downloading.
2032
2033 **Compatibility:** Firefox 68, Firefox ESR 68\
2034 **CCK2 Equivalent:** N/A
2035 **Preferences Affected:** `browser.download.useDownloadDir`
2036
2037 #### Windows
2038 ```
2039 Software\Policies\Mozilla\Firefox\PromptForDownloadLocation = 0x1 | 0x0
2040 ```
2041 #### macOS
2042 ```
2043 <dict>
2044 <key>PromptForDownloadLocation</key>
2045 <true/> | <false/>
2046 </dict>
2047 ```
2048 #### JSON
2049 ```
2050 {
2051 "policies": {
2052 "PromptForDownloadLocation": true | false
2053 }
2054 }
2055 ```
2056 ### Proxy
2057 Configure proxy settings. These settings correspond to the connection settings in Firefox preferences.
2058 To specify ports, append them to the hostnames with a colon (:).
2059
2060 `Mode` is the proxy method being used.
2061
2062 `Locked` is whether or not proxy settings can be changed.
2063
2064 `HTTPProxy` is the HTTP proxy server.
2065
2066 `UseHTTPProxyForAllProtocols` is whether or not the HTTP proxy should be used for all other proxies.
2067
2068 `SSLProxy` is the SSL proxy server.
2069
2070 `FTPProxy` is the FTP proxy server.
2071
2072 `SOCKSProxy` is the SOCKS proxy server
2073
2074 `SOCKSVersion` is the SOCKS version (4 or 5)
2075
2076 `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.
2077
2078 `AutoConfigURL` is a URL for proxy configuration (only used if Mode is autoConfig).
2079
2080 `AutoLogin` means do not prompt for authentication if password is saved.
2081
2082 `UseProxyForDNS` to use proxy DNS when using SOCKS v5.
2083
2084 **Compatibility:** Firefox 60, Firefox ESR 60\
2085 **CCK2 Equivalent:** `networkProxy*`\
2086 **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`
2087
2088 #### Windows
2089 ```
2090 Software\Policies\Mozilla\Firefox\Proxy\Mode = "none", "system", "manual", "autoDetect", "autoConfig"
2091 Software\Policies\Mozilla\Firefox\Proxy\Locked = 0x1 | 0x0
2092 Software\Policies\Mozilla\Firefox\=Proxy\HTTPProxy = https://httpproxy.example.com
2093 Software\Policies\Mozilla\Firefox\Proxy\UseHTTPProxyForAllProtocols = 0x1 | 0x0
2094 Software\Policies\Mozilla\Firefox\Proxy\SSLProxy = https://sslproxy.example.com
2095 Software\Policies\Mozilla\Firefox\Proxy\FTPProxy = https://ftpproxy.example.com
2096 Software\Policies\Mozilla\Firefox\Proxy\SOCKSProxy = https://socksproxy.example.com
2097 Software\Policies\Mozilla\Firefox\Proxy\SOCKSVersion = 0x4 | 0x5
2098 Software\Policies\Mozilla\Firefox\Proxy\Passthrough = <local>
2099 Software\Policies\Mozilla\Firefox\Proxy\AutoConfigURL = URL_TO_AUTOCONFIG
2100 Software\Policies\Mozilla\Firefox\Proxy\AutoLogin = 0x1 | 0x0
2101 Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0
2102 ```
2103 #### macOS
2104 ```
2105 <dict>
2106 <key>Proxy</key>
2107 <dict>
2108 <key>Mode</key>
2109 <string>none | system | manual | autoDetect| autoConfig</string>
2110 <key>Locked</key>
2111 <true> | </false>
2112 <key>HTTPProxy</key>
2113 <string>https://httpproxy.example.com</string>
2114 <key>UseHTTPProxyForAllProtocols</key>
2115 <true> | </false>
2116 <key>SSLProxy</key>
2117 <string>https://sslproxy.example.com</string>
2118 <key>FTPProxy</key>
2119 <string>https://ftpproxy.example.com</string>
2120 <key>SOCKSProxy</key>
2121 <string>https://socksproxy.example.com</string>
2122 <key>SOCKSVersion</key>
2123 <string>4 | 5</string>
2124 <key>Passthrough</key>
2125 <string>&lt;local>&gt;</string>
2126 <key>AutoConfigURL</key>
2127 <string>URL_TO_AUTOCONFIG</string>
2128 <key>AutoLogin</key>
2129 <true> | </false>
2130 <key>UseProxyForDNS</key>
2131 <true> | </false>
2132 </dict>
2133 </dict>
2134 ```
2135 ### JSON
2136 ```
2137 {
2138 "policies": {
2139 "Proxy": {
2140 "Mode": "none", "system", "manual", "autoDetect", "autoConfig",
2141 "Locked": [true, false],
2142 "HTTPProxy": "hostname",
2143 "UseHTTPProxyForAllProtocols": [true, false],
2144 "SSLProxy": "hostname",
2145 "FTPProxy": "hostname",
2146 "SOCKSProxy": "hostname",
2147 "SOCKSVersion": 4 | 5
2148 "Passthrough": "<local>",
2149 "AutoConfigURL": "URL_TO_AUTOCONFIG",
2150 "AutoLogin": [true, false],
2151 "UseProxyForDNS": [true, false]
2152 }
2153 }
2154 }
2155 ```
2156 ### RequestedLocales
2157 Set the the list of requested locales for the application in order of preference. It will cause the corresponding language pack to become active.
2158
2159 Note: For Firefox 68, this can now be a string so that you can specify an empty value.
2160
2161 **Compatibility:** Firefox 64, Firefox ESR 60.4, Updated in Firefox 68, Firefox ESR 68\
2162 **CCK2 Equivalent:** N/A\
2163 **Preferences Affected:** N/A
2164 #### Windows
2165 ```
2166 Software\Policies\Mozilla\Firefox\RequestedLocales\1 = "de"
2167 Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US"
2168
2169 or
2170
2171 Software\Policies\Mozilla\Firefox\RequestedLocales = "de,en-US"
2172 ```
2173 #### macOS
2174 ```
2175 <dict>
2176 <key>RequestedLocales</key>
2177 <array>
2178 <string>de</string>
2179 <string>en-US</string>
2180 </array>
2181 </dict>
2182
2183 or
2184
2185 <dict>
2186 <key>RequestedLocales</key>
2187 <string>de,en-US</string>
2188 </dict>
2189
2190 ```
2191 #### JSON
2192 ```
2193 {
2194 "policies": {
2195 "RequestedLocales": ["de", "en-US"]
2196 }
2197 }
2198
2199 or
2200
2201 {
2202 "policies": {
2203 "RequestedLocales": "de,en-US"
2204 }
2205 }
2206 ```
2207 ### SanitizeOnShutdown (Selective)
2208 Clear data on shutdown. Choose from Cache, Cookies, Download History, Form & Search History, Browsing History, Active Logins, Site Preferences and Offline Website Data.
2209
2210 **Compatibility:** Firefox 68, Firefox ESR 68\
2211 **CCK2 Equivalent:** N/A\
2212 **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`
2213 #### Windows
2214 ```
2215 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Cache = 0x1 | 0x0
2216 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Cookies = 0x1 | 0x0
2217 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Downloads = 0x1 | 0x0
2218 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\FormData = 0x1 | 0x0
2219 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\History = 0x1 | 0x0
2220 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Sessions = 0x1 | 0x0
2221 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\SiteSettings = 0x1 | 0x0
2222 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\OfflineApps = 0x1 | 0x0
2223 ```
2224 #### macOS
2225 ```
2226 <dict>
2227 <key>SanitizeOnShutdown</key>
2228 <dict>
2229 <key>Cache</key>
2230 <true/> | <false/>
2231 <key>Cookies</key>
2232 <true/> | <false/>
2233 <key>Downloads</key>
2234 <true/> | <false/>
2235 <key>FormData</key>
2236 <true/> | <false/>
2237 <key>History</key>
2238 <true/> | <false/>
2239 <key>Sessions</key>
2240 <true/> | <false/>
2241 <key>SiteSettings</key>
2242 <true/> | <false/>
2243 <key>OfflineApps</key>
2244 <true/> | <false/>
2245 </dict>
2246 </dict>
2247 ```
2248 #### JSON
2249 ```
2250 {
2251 "policies": {
2252 "SanitizeOnShutdown": {
2253 "Cache": true | false,
2254 "Cookies": true | false,
2255 "Downloads": true | false,
2256 "FormData": true | false,
2257 "History": true | false,
2258 "Sessions": true | false,
2259 "SiteSettings": true | false,
2260 "OfflineApps": true | false
2261 }
2262 }
2263 }
2264 ```
2265 ### SanitizeOnShutdown (All)
2266 Clear all data on shutdown, including Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data.
2267
2268 **Compatibility:** Firefox 60, Firefox ESR 60\
2269 **CCK2 Equivalent:** N/A\
2270 **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`
2271 #### Windows
2272 ```
2273 Software\Policies\Mozilla\Firefox\SanitizeOnShutdown = 0x1 | 0x0
2274 ```
2275 #### macOS
2276 ```
2277 <dict>
2278 <key>SanitizeOnShutdown</key>
2279 <true/> | <false/>
2280 </dict>
2281 ```
2282 #### JSON
2283 ```
2284 {
2285 "policies": {
2286 "SanitizeOnShutdown": true | false
2287 }
2288 }
2289 ```
2290 ### SearchBar
2291 Set whether or not search bar is displayed.
2292
2293 **Compatibility:** Firefox 60, Firefox ESR 60\
2294 **CCK2 Equivalent:** `showSearchBar`\
2295 **Preferences Affected:** N/A
2296
2297 #### Windows
2298 ```
2299 Software\Policies\Mozilla\Firefox\SearchBar = "unified" | "separate"
2300 ```
2301 #### macOS
2302 ```
2303 <dict>
2304 <key>SearchBar</key>
2305 <string>unified | separate</string>
2306 </dict>
2307 ```
2308
2309 #### JSON
2310 ```
2311 {
2312 "policies": {
2313 "SearchBar": "unified" | "separate"
2314 }
2315 }
2316 ```
2317
2318
2319
2320
2321
2322 ### SearchEngines (This policy is only available on the ESR.)
2323
2324 ### SearchEngines | Default
2325
2326 Set the default search engine. This policy is only available on the ESR.
2327
2328 **Compatibility:** Firefox ESR 60\
2329 **CCK2 Equivalent:** `defaultSearchEngine`\
2330 **Preferences Affected:** N/A
2331
2332 ### Windows
2333 ```
2334 Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
2335 ```
2336 #### macOS
2337 ```
2338 <dict>
2339 <key>SearchEngines</key>
2340 <dict>
2341 <key>Default</key>
2342 <string>NAME_OF_SEARCH_ENGINE</string>
2343 </dict>
2344 </dict>
2345 ```
2346 ### JSON
2347 ```
2348 {
2349 "policies": {
2350 "SearchEngines": {
2351 "Default": "NAME_OF_SEARCH_ENGINE"
2352 }
2353 }
2354 }
2355 ```
2356 ### SearchEngines | PreventInstalls
2357
2358 Prevent installing search engines from webpages.
2359
2360 **Compatibility:** Firefox ESR 60\
2361 **CCK2 Equivalent:** `disableSearchEngineInstall`\
2362 **Preferences Affected:** N/A
2363
2364 ### Windows
2365 ```
2366 Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
2367 ```
2368 #### macOS
2369 ```
2370 <dict>
2371 <key>SearchEngines</key>
2372 <dict>
2373 <key>PreventInstalls</key>
2374 <true/> | <false/>
2375 </dict>
2376 </dict>
2377 ```
2378 ### JSON
2379 ```
2380 {
2381 "policies": {
2382 "SearchEngines": {
2383 "PreventInstalls": true | false
2384 }
2385 }
2386 }
2387 ```
2388 ### SearchEngines | Remove
2389
2390 Hide built-in search engines. This policy is only available on the ESR.
2391
2392 **Compatibility:** Firefox ESR 60.2\
2393 **CCK2 Equivalent:** `removeDefaultSearchEngines` (removed all built-in engines)\
2394 **Preferences Affected:** N/A
2395
2396 ### Windows
2397 ```
2398 Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
2399 ```
2400 #### macOS
2401 ```
2402 <dict>
2403 <key>SearchEngines</key>
2404 <dict>
2405 <key>Remove</key>
2406 <array>
2407 <string>NAME_OF_SEARCH_ENGINE</string>
2408 </array>
2409 </dict>
2410 </dict>
2411 ```
2412 ### JSON
2413 ```
2414 {
2415 "policies": {
2416 "SearchEngines": {
2417 "Remove": ["NAME_OF_SEARCH_ENGINE"]
2418 }
2419 }
2420 }
2421 ```
2422 ### SearchEngines | Add
2423
2424 Add new search engines (up to five). This policy is only available on the ESR. `Name` and `URLTemplate` are required.
2425
2426 `Name` is the name of the search engine.
2427
2428 `URLTemplate` is the search URL with {searchTerms} to substitute for the search term.
2429
2430 `Method` is either GET or POST
2431
2432 `IconURL` is a URL for the icon to use.
2433
2434 `Alias` is a keyword to use for the engine.
2435
2436 `Description` is a description of the search engine.
2437
2438 `PostData` is the POST data as name value pairs separated by &.
2439
2440 `SuggestURLTemplate` is a search suggestions URL with {searchTerms} to substitute for the search term.
2441
2442 **Compatibility:** Firefox ESR 60 (POST support in Firefox ESR 68)\
2443 **CCK2 Equivalent:** `searchplugins`\
2444 **Preferences Affected:** N/A
2445
2446 #### Windows
2447 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Name = "Example1"
2448 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\URLTemplate = "https://www.example.org/q={searchTerms}"
2449 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Method = "GET" | "POST"
2450 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\IconURL = "https://www.example.org/favicon.ico"
2451 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Alias = "example"
2452 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description = "Example Description"
2453 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "https://www.example.org/suggestions/q={searchTerms}"
2454 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\PostData = "name=value&q={searchTerms}"
2455
2456 #### macOS
2457 ```
2458 <dict>
2459 <key>SearchEngines</key>
2460 <dict>
2461 <key>Add</key>
2462 <array>
2463 <dict>
2464 <key>Name</key>
2465 <string>Example1</string>
2466 <key>URLTemplate</key>
2467 <string>https://www.example.org/q={searchTerms}</string>
2468 <key>Method</key>
2469 <string>GET | POST </string>
2470 <key>IconURL</key>
2471 <string>https://www.example.org/favicon.ico</string>
2472 <key>Alias</key>
2473 <string>example</string>
2474 <key>Description</key>
2475 <string>Example Description</string>
2476 <key>SuggestURLTemplate</key>
2477 <string>https://www.example.org/suggestions/q={searchTerms}</string>
2478 <key>PostData</key>
2479 <string>name=value&q={searchTerms}</string>
2480 </dict>
2481 <array>
2482 </dict>
2483 </dict>
2484 ```
2485 ### JSON
2486 ```
2487 {
2488 "policies": {
2489 "SearchEngines": {
2490 "Add": [
2491 {
2492 "Name": "Example1",
2493 "URLTemplate": "https://www.example.org/q={searchTerms}",
2494 "Method": "GET" | "POST",
2495 "IconURL": "https://www.example.org/favicon.ico",
2496 "Alias": "example",
2497 "Description": "Description",
2498 "PostData": "name=value&q={searchTerms}",
2499 "SuggestURLTemplate": "https://www.example.org/suggestions/q={searchTerms}"
2500 }
2501 ]
2502 }
2503 }
2504 }
2505 ```
2506 ### SearchSuggestEnabled
2507
2508 Enable search suggestions.
2509
2510 **Compatibility:** Firefox 68, Firefox ESR 68\
2511 **CCK2 Equivalent:** N/A\
2512 **Preferences Affected:** `browser.urlbar.suggest.searches`,`browser.search.suggest.enabled`
2513
2514 ### Windows
2515 ```
2516 Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
2517 ```
2518 #### macOS
2519 ```
2520 <dict>
2521 <key>SearchSuggestEnabled</key>
2522 <true/> | <false/>
2523 </dict>
2524 ```
2525 ### JSON
2526 ```
2527 {
2528 "policies": {
2529 "SearchSuggestEnabled": true | false
2530 }
2531 }
2532 ```
2533 ### SecurityDevices
2534
2535 Install PKCS #11 modules.
2536
2537 **Compatibility:** Firefox 64, Firefox ESR 60.4\
2538 **CCK2 Equivalent:** `certs.devices`\
2539 **Preferences Affected:** N/A
2540
2541 #### Windows
2542 ```
2543 Software\Policies\Mozilla\Firefox\SecurityDevices\NAME_OF_DEVICE = PATH_TO_LIBRARY_FOR_DEVICE
2544 ```
2545 #### macOS
2546 ```
2547 <dict>
2548 <key>SecurityDevices</key>
2549 <dict>
2550 <key>NAME_OF_DEVICE</key>
2551 <string>PATH_TO_LIBRARY_FOR_DEVICE</string>
2552 </dict>
2553 </dict>
2554 ```
2555
2556 #### JSON
2557 ```
2558 {
2559 "policies": {
2560 "SecurityDevices": {
2561 "NAME_OF_DEVICE": "PATH_TO_LIBRARY_FOR_DEVICE"
2562 }
2563 }
2564 }
2565 ```
2566 ### SSLVersionMax
2567
2568 Set and lock the maximum version of TLS.
2569
2570 **Compatibility:** Firefox 66, Firefox ESR 60.6\
2571 **CCK2 Equivalent:** N/A\
2572 **Preferences Affected:** `security.tls.version.max`
2573
2574 #### Windows
2575 ```
2576 Software\Policies\Mozilla\Firefox\SSLVersionMax = "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2577 ```
2578 #### macOS
2579 ```
2580 <dict>
2581 <key>SSLVersionMax</key>
2582 <string>tls1 | tls1.1 | tls1.2 | tls1.3</string>
2583 </dict>
2584 ```
2585
2586 #### JSON
2587 ```
2588 {
2589 "policies": {
2590 "SSLVersionMax": "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2591 }
2592 }
2593 ```
2594 ### SSLVersionMin
2595
2596 Set and lock the minimum version of TLS.
2597
2598 **Compatibility:** Firefox 66, Firefox ESR 60.6\
2599 **CCK2 Equivalent:** N/A\
2600 **Preferences Affected:** `security.tls.version.min`
2601
2602 #### Windows
2603 ```
2604 Software\Policies\Mozilla\Firefox\SSLVersionMin = "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2605 ```
2606 #### macOS
2607 ```
2608 <dict>
2609 <key>SSLVersionMin</key>
2610 <string>tls1 | tls1.1 | tls1.2 | tls1.3</string>
2611 </dict>
2612 ```
2613
2614 #### JSON
2615 ```
2616 {
2617 "policies": {
2618 "SSLVersionMin": "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
2619 }
2620 }
2621 ```
2622 ### SupportMenu
2623 Add a menuitem to the help menu for specifying support information.
2624
2625 **Compatibility:** Firefox 68.0.1, Firefox ESR 68.0.1\
2626 **CCK2 Equivalent:** helpMenu\
2627 **Preferences Affected:** N/A
2628
2629 #### Windows
2630 ```
2631 Software\Policies\Mozilla\Firefox\SupportMenu\Title = "Support Menu"
2632 Software\Policies\Mozilla\Firefox\SupportMenu\URL = "http://example.com/support"
2633 Software\Policies\Mozilla\Firefox\SupportMenu\Title = "S"
2634 ```
2635 #### macOS
2636 ```
2637 <dict>
2638 <key>SupportMenu</key>
2639 <dict>
2640 <key>Title</key>
2641 <string>SupportMenu</string>
2642 <key>URL</key>
2643 <string>http://example.com/support</string>
2644 <key>AccessKey</key>
2645 <string>S</string>
2646 </dict>
2647 </dict>
2648 ```
2649 ### JSON
2650 ```
2651 {
2652 "policies": {
2653 "SupportMenu": {
2654 "Title": "Support Menu",
2655 "URL": "http://example.com/support",
2656 "AccessKey": "S"
2657 }
2658 }
2659 }
2660 ```
2661 ### WebsiteFilter
2662 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.
2663
2664 **Compatibility:** Firefox 60, Firefox ESR 60\
2665 **CCK2 Equivalent:** N/A\
2666 **Preferences Affected:** N/A
2667
2668 #### Windows
2669 ```
2670 Software\Policies\Mozilla\Firefox\WebsiteFilters\Block\1 = "<all_urls>"
2671 Software\Policies\Mozilla\Firefox\WebsiteFilters\Exceptions\1 = "http://example.org/*"
2672 ```
2673 #### macOS
2674 ```
2675 <dict>
2676 <key>WebsiteFilter</key>
2677 <dict>
2678 <key>Block</key>
2679 <array>
2680 <string><all_urls></string>
2681 </array>
2682 <key>Exceptions</key>
2683 <array>
2684 <string>http://example.org/*</string>
2685 </array>
2686 </dict>
2687
2688 </dict>
2689 ```
2690 ### JSON
2691 ```
2692 {
2693 "policies": {
2694 "WebsiteFilter": {
2695 "Block": ["<all_urls>"],
2696 "Exceptions": ["http://example.org/*"]
2697 }
2698 }
2699 }
2700 ```

patrick-canterino.de