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

patrick-canterino.de