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

patrick-canterino.de