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

patrick-canterino.de