]> git.p6c8.net - policy-templates.git/blob - README-new.md
1c2fb34342df0197683184cbab709e27fadbab21
[policy-templates.git] / README-new.md
1 **IMPORTANT**: This file is in active development along with the policies in Firefox. To get the policy information that corresponds to a specific release, go to https://github.com/mozilla/policy-templates/releases.
2
3 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.
4
5 The content of the JSON file should look like this:
6 ```
7 {
8 "policies": {
9 ...POLICIES...
10 }
11 }
12 ```
13 Policies are documented below.
14
15
16 **Note**: though comments are used in this readme file for documentation, comments are not valid in actual JSON files. Remove all comments before attempting to deploy.
17
18 ### AppUpdateURL
19 This policy is for changing the URL used for application update
20 ```
21 {
22 "AppUpdateURL": "http://yoursite.com"
23 }
24 ```
25
26
27 ### Authentication
28 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
29 ```
30 {
31 "policies": {
32 "Authentication": {
33 "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
34 "Delegated": ["mydomain.com", "https://myotherdomain.com"],
35 "NTLM": ["mydomain.com", "https://myotherdomain.com"],
36 "AllowNonFQDN": {
37 "SPNEGO": true,
38 "NTLM": true
39 }
40 }
41 }
42 }
43 ```
44 ### BlockAboutAddons
45 This policy removes access to about:addons.
46 ```
47 {
48 "policies": {
49 "BlockAboutAddons": true
50 }
51 }
52 ```
53 ### BlockAboutConfig
54 This policy removes access to about:config.
55 ```
56 {
57 "policies": {
58 "BlockAboutConfig": true
59 }
60 }
61 ```
62 ### BlockAboutProfiles
63 This policy removes access to about:profiles.
64 ```
65 {
66 "policies": {
67 "BlockAboutProfiles": true
68 }
69 }
70 ```
71 ### BlockAboutSupport
72 This policy removes access to about:support.
73 ```
74 {
75 "policies": {
76 "BlockAboutSupport": true
77 }
78 ```
79 ### Bookmarks
80 This policy allows you to specify bookmarks. You can have any number of bookmarks, although only ten are specified in the ADMX file.
81 Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
82 same folder name are grouped together.
83 ```
84 {
85 "policies": {
86 "Bookmarks": [
87 {
88 "Title": "Example",
89 "URL": "http://example.org",
90 "Favicon": "http://example.com/favicon.ico",
91 "Placement": ["toolbar", "menu"],
92 "Folder": "FolderName"
93 }
94 ]
95 }
96 }
97 ```
98 ### CaptivePortal
99 A Boolean value that enables or disables captive portal support by setting and locking the preference `network.captive-portal-service.enabled`.
100
101 **Compatibility:** Firefox 67, Firefox ESR 60.7\
102 **CCK2 Equivalent:** N/A\
103 **Preferences Affected:** `network.captive-portal-service.enabled`
104
105 #### Windows
106 | Type | Registry Location |
107 | ---- | ----------------- |
108 | `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\CaptivePortal` |
109
110 #### macOS
111 ```
112 <dict>
113 <key>CaptivePortal</key>
114 <true/> | <false/>
115 </dict>
116 ```
117
118 #### JSON
119 ```
120 {
121 "policies": {
122 "CaptivePortal": true | false
123 }
124 }
125 ```
126 ### Certificates
127 This policy can be used to install certificates or to read certificates from the system certificate store on Mac and Windows.
128
129 The ImportEnterpriseRoots key will cause Firefox to import 3rd party certificates that have been added by a user administrator from the system certificate store.
130 It does not import all certificates. These certificates will not display in the Firefox certificates manager.
131
132 The Install Certificates key by default will search for certificates in the locations listed below.
133 Starting in Firefox 65 you can specify a fully qualified path including UNC. (See cert3.der and cert4.pem, in example).
134
135 **Be advised if you wish to load a certificate from a UNC path you must use double backslashes.**
136 Example: \\\\SERVER\\CERTS\\CERT5.PEM
137
138
139 If Firefox does not find something at your fully qualified path, it will search the default directories.
140
141 Certificates can be located in the following locations:
142 - Windows
143 - %USERPROFILE%\AppData\Local\Mozilla\Certificates
144 - %USERPROFILE%\AppData\Roaming\Mozilla\Certificates
145 - macOS
146 - /Library/Application Support/Mozilla/Certificates
147 - ~/Library/Application Support/Mozilla/Certificates
148 - Linux
149 - /usr/lib/mozilla/certificates
150 - /usr/lib64/mozilla/certificates
151 - ~/.mozilla/certificates
152
153
154 ```
155 {
156 "policies": {
157 "Certificates": {
158 "ImportEnterpriseRoots": true,
159 "Install": ["cert1.der", "cert2.pem", "%SYSTEMDRIVE%\\Company\\cert3.der", "/Library/Company/cert4.pem", "\\\\server\\certs\\cert.pem"]
160 }
161 }
162 }
163 ```
164 ### Cookies
165 This policy controls various settings related to cookies.
166 ```
167 {
168 "policies": {
169 "Cookies": {
170 "Allow": ["http://example.org/"], /* Domains where cookies are always allowed */
171 "Block": ["http://example.edu/"], /* Domains where cookies are always blocked */
172 "Default": [true|false], /* This sets the default value for "Accept cookies from websites" */
173 "AcceptThirdParty": ["always", "never", "from-visited"], /* This sets the default value for "Accept third-party cookies" */
174 "ExpireAtSessionEnd": [true|false], /* This determines when cookies expire */
175 "RejectTracker": [true|false], /* Only reject trackers */
176 "Locked": [true|false] /* If this is true, cookies preferences can't be changed */
177 }
178 }
179 }
180 ```
181 ### DNSOverHTTPS
182 This policy configures DNS over HTTPS.
183 ```
184 {
185 "policies": {
186 "DNSOverHTTPS": {
187 "Enabled": [true|false],
188 "ProviderURL": "URL_TO_ALTERNATE_PROVIDER",
189 "Locked": [true|false]
190 }
191 }
192 }
193 ```
194 ### DisableSetDesktopBackground
195 This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
196 ```
197 {
198 "policies": {
199 "DisableSetDesktopBackground": true
200 }
201 }
202 ```
203 ### DisableMasterPasswordCreation
204 If this policy is set to true, the master password functionality is removed.
205 ```
206 {
207 "policies": {
208 "DisableMasterPasswordCreation": [true|false]
209 }
210 }
211 ```
212 ### DisableAppUpdate
213 This policy turns off application updates.
214 ```
215 {
216 "policies": {
217 "DisableAppUpdate": true
218 }
219 }
220 ```
221 ### DisableBuiltinPDFViewer
222 This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.
223 ```
224 {
225 "policies": {
226 "DisableBuiltinPDFViewer": true
227 }
228 }
229 ```
230 ### DisableDeveloperTools
231 This policy removes access to all developer tools.
232 ```
233 {
234 "policies": {
235 "DisableDeveloperTools": true
236 }
237 }
238 ```
239 ### DisableFeedbackCommands
240 This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site).
241 ```
242 {
243 "policies": {
244 "DisableFeedbackCommands": true
245 }
246 }
247 ```
248 ### DisableFirefoxScreenshots
249 This policy removes access to Firefox Screenshots.
250 ```
251 {
252 "policies": {
253 "DisableFirefoxScreenshots": true
254 }
255 }
256 ```
257 ### DisableFirefoxAccounts
258 This policy disables Sync.
259 ```
260 {
261 "policies": {
262 "DisableFirefoxAccounts": true
263 }
264 }
265 ```
266 ### DisableFirefoxStudies
267 This policy disables Firefox studies (Shield).
268 ```
269 {
270 "policies": {
271 "DisableFirefoxStudies": true
272 }
273 }
274 ```
275 ### DisableForgetButton
276 This policy disables the "Forget" button.
277 ```
278 {
279 "policies": {
280 "DisableForgetButton": true
281 }
282 }
283 ```
284 ### DisableFormHistory
285 This policy turns off the browser.formfill.enable preferences.
286 ```
287 {
288 "policies": {
289 "DisableFormHistory": true
290 }
291 }
292 ```
293 ### DisablePocket
294 This policy turns off Pocket.
295 ```
296 {
297 "policies": {
298 "DisablePocket": true
299 }
300 }
301 ```
302 ### DisablePrivateBrowsing
303 This policy removes access to private browsing.
304 ```
305 {
306 "policies": {
307 "DisablePrivateBrowsing": true
308 }
309 }
310 ```
311 ### DisableProfileImport
312 This policy disables the "Import data from another browser" option in the bookmarks window.
313 ```
314 {
315 "policies": {
316 "DisableProfileImport": true
317 }
318 }
319 ```
320 ### DisableProfileRefresh
321 This policy disables the Refresh Firefox button on about:support and support.mozilla.org.
322 ```
323 {
324 "policies": {
325 "DisableProfileRefresh": true
326 }
327 }
328 ```
329 ### DisableSafeMode
330 This policy disables safe mode on Windows and macOS only.
331 ```
332 {
333 "policies": {
334 "DisableSafeMode": true
335 }
336 }
337 ```
338 ### DisableSecurityBypass
339 This policy prevents the user from bypassing security in certain cases.
340 ```
341 {
342 "policies": {
343 "DisableSecurityBypass": {
344 "InvalidCertificate": [true|false], /* Prevents adding an exception when an invalid certificate is shown */
345 "SafeBrowsing": [true|false] /* Prevents selecting "ignore the risk" and visiting a harmful site anyway */
346 }
347 }
348 }
349 ```
350 ### DisableSystemAddonUpdate
351 This policy prevents system add-ons from being updated or installed.
352 ```
353 {
354 "policies": {
355 "DisableSystemAddonUpdate": true
356 }
357 }
358 ```
359 ### DisableTelemetry
360 This policy prevents the upload of telemetry data.
361
362 Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
363 ```
364 {
365 "policies": {
366 "DisableTelemetry": true
367 }
368 }
369 ```
370 ### DisplayBookmarksToolbar
371 This policy turns on the bookmarks toolbar by default. A user can still turn it off, and it will stay off.
372 ```
373 {
374 "policies": {
375 "DisplayBookmarksToolbar": true
376 }
377 }
378 ```
379 ### DisplayMenuBar
380 This policy turns on the menubar by default. A user can still turn it off, and it will stay off.
381 ```
382 {
383 "policies": {
384 "DisplayMenuBar": true
385 }
386 }
387 ```
388 ### DontCheckDefaultBrowser
389 This policy stops Firefox from checking if it is the default browser at startup.
390 ```
391 {
392 "policies": {
393 "DontCheckDefaultBrowser": true
394 }
395 }
396 ```
397 ### EnableTrackingProtection
398 This policy affects tracking protection.
399
400 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.
401
402 If Value is set to false, tracking protection is disabled and locked in both the regular browser and private browsing.
403
404 If Value is set to true, tracking protection is enabled by default in both the regular browser and private browsing.
405
406 You can choose to set the Locked value if you want to prevent the user from changing it.
407 ```
408 {
409 "policies": {
410 "EnableTrackingProtection": {
411 "Value": [true, false],
412 "Locked": [true, false]
413 }
414 }
415 ```
416 ### Extensions
417 This policy controls the installation, uninstallation and locking of extensions. Locked extensions cannot be disabled or uninstalled.
418 For Install, you specify a list of URLs or paths.
419 For Uninstall and Locked, you specify extension IDs.
420 ```
421 {
422 "policies": {
423 "Extensions": {
424 "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"],
425 "Uninstall": ["addon_id@mozilla.org"],
426 "Locked": ["addon_id@mozilla.org"]
427 }
428 }
429 }
430 ```
431 ### ExtensionUpdate
432 This policy enables or disables extension updates by setting and locking the preference `extensions.update.enabled`.
433 ```
434 {
435 "policies": {
436 "ExtensionUpdate": [true|false]
437 }
438 ```
439 ### HardwareAcceleration
440 This policy disables hardware acceleration by locking the preference layers.acceleration.disabled to true.
441 ```
442 {
443 "policies": {
444 "HardwareAcceleration": false
445 }
446 }
447 ```
448 ### NoDefaultBookmarks
449 This policy prevents the default bookmarks or the Smart Bookmarks (Most Visited, Recent Tags) from being created. Note: this policy is only effective if used before the first run of the profile.
450 ```
451 {
452 "policies": {
453 "NoDefaultBookmarks": true
454 }
455 }
456 ```
457 ### OfferToSaveLogins
458 This policy sets the signon.rememberSignons preference. It determines whether or not Firefox offers to save passwords. It can either be enabled or disabled.
459 ```
460 {
461 "policies": {
462 "OfferToSaveLogins": true
463 }
464 }
465 ```
466 ### Homepage
467 This policy sets the default homepage value and the default start page. It can also be used to lock the homepage or add additional homepages.
468 ```
469 {
470 "policies": {
471 "Homepage": {
472 "URL": "http://example.com/",
473 "Locked": true,
474 "Additional": ["http://example.org/",
475 "http://example.edu/"],
476 "StartPage": ["none", "homepage", "previous-session"]
477 }
478 }
479 }
480 ```
481 ### PopupBlocking
482 This policy sets domains for which pop-up windows are allowed. It also sets the default pop-up policy.
483 ```
484 {
485 "policies": {
486 "PopupBlocking": {
487 "Allow": ["http://example.org/",
488 "http://example.edu/"],
489 "Default": [true|false], /* If this is set to false, pop-up window are enabled by default. */
490 "Locked": [true|false]
491 }
492 }
493 }
494 ```
495 ### InstallAddonsPermission
496 This policy sets domains that can install extensions, as well as the default behavior.
497 ```
498 {
499 "policies": {
500 "InstallAddonsPermission": {
501 "Allow": ["http://example.org/",
502 "http://example.edu/"],
503 "Default": [true|false] /* If this is set to false, add-ons cannot be installed by the user */
504 }
505 }
506 }
507 ```
508 ### FlashPlugin
509 This policy sets the behavior of Flash on the specified domains, as well as the default behavior.
510 ```
511 {
512 "policies": {
513 "FlashPlugin": {
514 "Allow": ["http://example.org/"], /* Sites on the allow list do not override Flash being completely disabled */
515 "Block": ["http://example.edu/"],
516 "Default": [true|false], /* If this is set to true, Flash is always enabled. If it is set to false, Flash is never enabled */
517 "Locked": [true|false]
518 }
519 }
520 }
521 ```
522 ### NetworkPrediction
523 This policy enables or disables network prediction (DNS prefetching) by setting and locking the preferences `network.dns.disablePrefetch` and `network.dns.disablePrefetchFromHTTPS`.
524 ```
525 {
526 "policies": {
527 "NetworkPrediction": [true|false]
528 }
529 ```
530 ### OverrideFirstRunPage
531 This policy allows you to override the first run page. If you leave the URL blank, the first run page will not be displayed.
532 ```
533 {
534 "policies": {
535 "OverrideFirstRunPage": "http://example.org"
536 }
537 }
538 ```
539 ### OverridePostUpdatePage
540 This policy allows you to override the upgrade page. If you leave the URL blank, the upgrade page will not be displayed.
541 ```
542 {
543 "policies": {
544 "OverridePostUpdatePage": "http://example.org"
545 }
546 }
547 ```
548 ### Permissions
549 This policy allows you to change the permissions associated with camera, microphone, location, and notifications
550 ```
551 {
552 "policies": {
553 "Permissions": {
554 "Camera": {
555 "Allow": ["http://example.org/"], /* Origins where camera access is allowed by default */
556 "Block": ["http://example.org/"], /* Origins where camera access is blocked by default */
557 "BlockNewRequests": [true|false], /* Block new requests to access the camera */
558 "Locked": [true|false] /* Don't allow the user to change the camera preferences */
559 },
560 "Microphone": {
561 "Allow": ["http://example.org/"], /* Origins where microphone access is allowed by default */
562 "Block": ["http://example.org/"], /* Origins where microphone access is blocked by default */
563 "BlockNewRequests": [true|false], /* Block new requests to access the microphone */
564 "Locked": [true|false] /* Don't allow the user to change the microphone preferences */
565 },
566 "Location": {
567 "Allow": ["http://example.org/"], /* Origins where location access is allowed by default */
568 "Block": ["http://example.org/"], /* Origins where location access is blocked by default */
569 "BlockNewRequests": [true|false], /* Block new requests to access location */
570 "Locked": [true|false] /* Don't allow the user to change the location preferences */
571 },
572 "Notifications": {
573 "Allow": ["http://example.org/"], /* Origins where sending notifications is allowed by default */
574 "Block": ["http://example.org/"], /* Origins where sending notifications is blocked by default */
575 "BlockNewRequests": [true|false], /* Block new requests to send notifications */
576 "Locked": [true|false] /* Don't allow the user to change the notification preferences */
577 }
578 }
579 }
580 }
581 ```
582 ### Proxy
583 This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
584 To specify ports, append them to the hostnames with a colon (:). If Locked is set to true, the values can't be changed by the user.
585 ```
586 {
587 "policies": {
588 "Proxy": {
589 "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"],
590 "Locked": [true, false],
591 "HTTPProxy": "hostname",
592 "UseHTTPProxyForAllProtocols": [true, false],
593 "SSLProxy": "hostname",
594 "FTPProxy": "hostname",
595 "SOCKSProxy": "hostname",
596 "SOCKSVersion": [4, 5],
597 "Passthrough": "List of passthrough addresses/domains",
598 "AutoConfigURL": "URL_TO_AUTOCONFIG",
599 "AutoLogin": [true, false],
600 "UseProxyForDNS": [true, false]
601 }
602 }
603 }
604 ```
605 ### RequestedLocales
606 This policy sets the list of requested locales for the application in order of preference. It will cause the corresponding language pack to become active.
607 ```
608 {
609 "policies": {
610 "RequestedLocales": ["de", "en-US"]
611 }
612 }
613 ```
614 ### SanitizeOnShutdown
615 If this policy is set to true, all data is cleared when Firefox is closed. This includes Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data.
616 ```
617 {
618 "policies": {
619 "SanitizeOnShutdown": [true|false]
620 }
621 }
622 ```
623 ### SearchBar
624 This policy can be used to determine if the search bar is separate or combined with the URL bar.
625 ```
626 {
627 "policies": {
628 "SearchBar": ["unified", "separate"]
629 }
630 }
631 ```
632 ### WebsiteFilter
633 This policy blocks 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.
634 ```
635 {
636 "policies": {
637 "WebsiteFilter": {
638 "Block": ["<all_urls>"],
639 "Exceptions": ["http://example.org/*"]
640 }
641 }
642 }
643 ```
644 ### Search Engines (This policy is only available on the ESR.)
645 This policy allows you to add new search engines, remove or hide search engines, as well as set the default and prevent the install of search engines from web pages. Only Name and URLTemplate is required.
646 ```
647 {
648 "policies": {
649 "SearchEngines": {
650 "Add": [
651 {
652 "Name": "",
653 "URLTemplate": "URL including {searchTerms} to substitute for the terms",
654 "Method": ["GET", "POST"],
655 "IconURL": "URL to icon",
656 "Alias": "Alias that can be used to access the engine",
657 "Description": "Description",
658 "SuggestURLTemplate": "URL for suggestions using {searchTerms}"
659 }
660 ],
661 "Default": "Name of engine",
662 "PreventInstalls": [true|false],
663 "Remove": ["Twitter", "Wikipedia (en)"]
664 }
665 }
666 }
667 ```
668 ### SecurityDevices
669 This policy allows you to add PKCS #11 Modules
670 ```
671 {
672 "policies": {
673 "SecurityDevices": {
674 "NAME_OF_DEVICE": "PATH_TO_LIBRARY_FOR_DEVICE"
675 }
676 }
677 }
678 ```
679 ### SSLVersionMax
680 A String value that sets and locks the maximum version of TLS
681
682 **Compatibility:** Firefox 67, Firefox ESR 60.7\
683 **CCK2 Equivalent:** N/A\
684 **Preferences Affected:** `security.tls.version.max`
685
686 #### Windows
687 | Type | Registry Location |
688 | ---- | ----------------- |
689 | `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SSLVersionMax` |
690
691 #### macOS
692 ```
693 <dict>
694 <key>SSLVersionMax</key>
695 <string>tls1 | tls1.1 | tls1.2 | tls1.3<string>
696 </dict>
697 ```
698
699 #### JSON
700 ```
701 {
702 "policies": {
703 "SSLVersionMax": "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
704 }
705 }
706 ```
707 ### SSLVersionMin
708 A String value that sets and locks the minimum version of TLS
709
710 **Compatibility:** Firefox 67, Firefox ESR 60.7\
711 **CCK2 Equivalent:** N/A\
712 **Preferences Affected:** `security.tls.version.min`
713
714 #### Windows
715 | Type | Registry Location |
716 | ---- | ----------------- |
717 | `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SSLVersionMin` |
718
719 #### macOS
720 ```
721 <dict>
722 <key>SSLVersionMin</key>
723 <string>tls1 | tls1.1 | tls1.2 | tls1.3<string>
724 </dict>
725 ```
726
727 #### JSON
728 ```
729 {
730 "policies": {
731 "SSLVersionMin": "tls1" | "tls1.1" | "tls1.2" | "tls1.3"
732 }
733 }
734 ```

patrick-canterino.de