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

patrick-canterino.de