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

patrick-canterino.de