X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/1f0f6efbc4d8d18adaed29f343e8c69d7fbb5368..a927f934c446a41270413724d41af875ba801580:/README.md?ds=inline diff --git a/README.md b/README.md index fc0e944..8b5a113 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -**IMPORTANT**: This file is in active development along with the policies in Firefox. Make sure to check the compatibility section to see if a policy is available in a specific version of Firefox. To get the policy information that corresponds to a specific release, go to https://github.com/mozilla/policy-templates/releases. - 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. | Policy Name | Description @@ -36,13 +34,17 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`DisableSystemAddonUpdate`](#disablesystemaddonupdate)** | Prevent system add-ons from being installed or update. | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar. -| **[`DisplayMenuBar`](#displaymenubar)** | Set the initial state of the menubar +| **[`DisplayMenuBar`](#displaymenubar)** | Set the initial state of the menubar. | **[`DNSOverHTTPS`](#dnsoverhttps)** | Configure DNS over HTTPS. | **[`DontCheckDefaultBrowser`](#dontcheckdefaultbrowser)** | Don't check if Firefox is the default browser at startup. +| **[`DefaultDownloadDirectory`](#defaultdownloaddirectory)** | Set the default download directory. +| **[`DownloadDirectory`](#downloaddirectory)** | Set and lock the download directory. | **[`EnableTrackingProtection`](#enabletrackingprotection)** | Configure tracking protection. +| **[`EnterprisePoliciesEnabled`](#enterprisepoliciesenabled)** | Enable policy support on macOS. | **[`Extensions`](#extensions)** | Control the installation, uninstallation and locking of extensions. | **[`ExtensionUpdate`](#extensionupdate)** | Control extension updates. | **[`FlashPlugin`](#flashplugin)** | Configure the default Flash plugin policy as well as origins for which Flash is allowed. +| **[`FirefoxHome`](#firefoxhome)** | Customize the Firefox Home page. | **[`HardwareAcceleration`](#hardwareacceleration)** | Control hardware acceleration. | **[`Homepage`](#homepage)** | Configure the default homepage and how Firefox starts. | **[`InstallAddonsPermission`](#installaddonspermission)** | Configure the default extension install policy as well as origins for extension installs are allowed. @@ -56,9 +58,11 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`Permissions`](#permissions)** | Set permissions associated with camera, microphone, location, and notifications. | **[`PopupBlocking`](#popupblocking)** | Configure the default pop-up window policy as well as origins for which pop-up windows are allowed. | **[`Preferences`](#preferences)** | Set and lock some preferences. +| **[`PromptForDownloadLocation`](#promptfordownloadlocation)** | Ask where to save each file before downloading. | **[`Proxy`](#proxy)** | Configure proxy settings. | **[`RequestedLocales`](#requestedlocales)** | Set the the list of requested locales for the application in order of preference. -| **[`SanitizeOnShutdown`](#sanitizeonshutdown)** | Clear all data on shutdown. +| **[`SanitizeOnShutdown` (All)](#sanitizeonshutdown-all)** | Clear all data on shutdown. +| **[`SanitizeOnShutdown` (Selective)](#sanitizeonshutdown-selective)** | Clear data on shutdown. | **[`SearchBar`](#searchbar)** | Set whether or not search bar is displayed. | **[`SearchEngines`](#searchengines-this-policy-is-only-available-on-the-esr)** | | **[`SearchEngines -> Default`](#searchengines--default)** | Set the default search engine. @@ -69,9 +73,9 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`SearchSuggestEnabled`](#searchsuggestenabled)** | Enable search suggestions. | **[`SSLVersionMax`](#sslversionmax)** | Set and lock the maximum version of TLS. | **[`SSLVersionMin`](#sslversionmin)** | Set and lock the minimum version of TLS. +| **[`SupportMenu`](#supportmenu)** | Add a menuitem to the help menu for specifying support information. | **[`WebsiteFilter`](#websitefilter)** | Block websites from being visited. - ### AppUpdateURL Change the URL for application update. @@ -1153,6 +1157,60 @@ Software\Policies\Mozilla\Firefox\DontCheckDefaultBrowser = 0x1 | 0x0 } } ``` +### DefaultDownloadDirectory +Set the default download directory. + +You can use ${home} for the native home directory. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `browser.download.dir`,`browser.download.folderList` + +#### Windows +``` +Software\Policies\Mozilla\Firefox\DefaultDownloadDirectory = "${home}\Downloads" +``` +#### macOS +``` + + DefaultDownloadDirectory + ${home}/Downloads + +``` +#### JSON +``` +{ + "policies": { + "DefaultDownloadDirectory": "${home}/Downloads" +} +``` +### DownloadDirectory +Set and lock the download directory. + +You can use ${home} for the native home directory. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `browser.download.dir`,`browser.download.folderList`,`browser.download.useDownloadDir` + +#### Windows +``` +Software\Policies\Mozilla\Firefox\DownloadDirectory = "${home}\Downloads" +``` +#### macOS +``` + + DownloadDirectory + ${home}/Downloads + +``` +#### JSON +``` +{ + "policies": { + "DownloadDirectory": "${home}/Downloads" +} +``` ### EnableTrackingProtection Configure tracking protection. @@ -1194,6 +1252,20 @@ Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Locked = 0x1 | 0x0 } } ``` +### EnterprisePoliciesEnabled +Enable policy support on macOS. + +**Compatibility:** Firefox 63, Firefox ESR 60.3 (macOS only)\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### macOS +``` + + EnterprisePoliciesEnabled + + +``` ### Extensions Control the installation, uninstallation and locking of extensions. @@ -1249,6 +1321,9 @@ Software\Policies\Mozilla\Firefox\Extensions\Locked\1 = "addon_id@mozilla.org" } } ``` +### ExtensionSettings +Do NOT use this policy. You risk uninstalling your search extensions. + ### ExtensionUpdate Control extension updates. @@ -1330,6 +1405,57 @@ Software\Policies\Mozilla\Firefox\FlashPlugin\Locked = 0x1 | 0x0 } } ``` +### FirefoxHome +Customize the Firefox Home page. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**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` + +#### Windows +``` +Software\Policies\Mozilla\Firefox\FirefoxHome\Search = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FirefoxHome\TopSites = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FirefoxHome\Highlights = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FirefoxHome\Pocket = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FirefoxHome\Snippets = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FirefoxHome\Locked = 0x1 | 0x0 +``` +#### macOS +``` + + FirefoxHome + + Search + | + TopSites + | + Highlights + | + Pocket + | + Snippets + | + Locked + | + + +``` +#### JSON +``` +{ + "policies": { + "FirefoxHome": { + "Search": true | false, + "TopSites": true | false, + "Highlights": true | false, + "Pocket": true | false, + "Snippets": true | false, + "Locked": true | false + } + } +} +``` ### HardwareAcceleration Control hardware acceleration. @@ -1613,7 +1739,7 @@ Software\Policies\Mozilla\Firefox\OverrideFirstRunPage = "http://example.org" ``` { "policies": { - "OverrideFirstRunPage": ""http://example.org"" + "OverrideFirstRunPage": "http://example.org" } ``` ### OverridePostUpdatePage @@ -1638,7 +1764,7 @@ Software\Policies\Mozilla\Firefox\OverridePostUpdatePage = "http://example.org" ``` { "policies": { - "OverridePostUpdatePage": ""http://example.org"" + "OverridePostUpdatePage": "http://example.org" } ``` ### Permissions @@ -1867,7 +1993,7 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v #### macOS ``` - Preference + Preferences boolean_preference_name | @@ -1880,13 +2006,39 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v ``` { "policies": { - "Preference": { + "Preferences": { "boolean_preference_name": true | false, "string_preference_name": "string_value" } } } ``` +### PromptForDownloadLocation +Ask where to save each file before downloading. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A +**Preferences Affected:** `browser.download.useDownloadDir` + +#### Windows +``` +Software\Policies\Mozilla\Firefox\PromptForDownloadLocation = 0x1 | 0x0 +``` +#### macOS +``` + + PromptForDownloadLocation + | + +``` +#### JSON +``` +{ + "policies": { + "PromptForDownloadLocation": true | false + } +} +``` ### Proxy Configure proxy settings. These settings correspond to the connection settings in Firefox preferences. To specify ports, append them to the hostnames with a colon (:). @@ -1990,13 +2142,19 @@ Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0 ### RequestedLocales Set the the list of requested locales for the application in order of preference. It will cause the corresponding language pack to become active. -**Compatibility:** Firefox 64, Firefox ESR 60.4\ +Note: For Firefox 68, this can now be a string so that you can specify an empty value. + +**Compatibility:** Firefox 64, Firefox ESR 60.4, Updated in Firefox 68, Firefox ESR 68\ **CCK2 Equivalent:** N/A\ **Preferences Affected:** N/A #### Windows ``` Software\Policies\Mozilla\Firefox\RequestedLocales\1 = "de" Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US" + +or + +Software\Policies\Mozilla\Firefox\RequestedLocales = "de,en-US" ``` #### macOS ``` @@ -2007,6 +2165,14 @@ Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US" en-US + +or + + + RequestedLocales + de,en-US + + ``` #### JSON ``` @@ -2015,13 +2181,79 @@ Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US" "RequestedLocales": ["de", "en-US"] } } + +or + +{ + "policies": { + "RequestedLocales": "de,en-US" + } +} +``` +### SanitizeOnShutdown (Selective) +Clear data on shutdown. Choose from Cache, Cookies, Download History, Form & Search History, Browsing History, Active Logins, Site Preferences and Offline Website Data. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**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` +#### Windows +``` +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Cache = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Cookies = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Downloads = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\FormData = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\History = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Sessions = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\SiteSettings = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\OfflineApps = 0x1 | 0x0 +``` +#### macOS +``` + + SanitizeOnShutdown + + Cache + | + Cookies + | + Downloads + | + FormData + | + History + | + Sessions + | + SiteSettings + | + OfflineApps + | + + +``` +#### JSON +``` +{ + "policies": { + "SanitizeOnShutdown": { + "Cache": true | false, + "Cookies": true | false, + "Downloads": true | false, + "FormData": true | false, + "History": true | false, + "Sessions": true | false, + "SiteSettings": true | false, + "OfflineApps": true | false + } + } +} ``` -### SanitizeOnShutdown +### SanitizeOnShutdown (All) Clear all data on shutdown, including Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data. **Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** N/A\ -**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` +**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` #### Windows ``` Software\Policies\Mozilla\Firefox\SanitizeOnShutdown = 0x1 | 0x0 @@ -2175,7 +2407,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE ``` ### SearchEngines | Add -Adddd new search engines (up to five). This policy is only available on the ESR. `Name` and `URLTemplate` are required. +Add new search engines (up to five). This policy is only available on the ESR. `Name` and `URLTemplate` are required. `Name` is the name of the search engine. @@ -2189,9 +2421,11 @@ Adddd new search engines (up to five). This policy is only available on the ESR. `Description` is a description of the search engine. +`PostData` is the POST data as name value pairs separated by &. + `SuggestURLTemplate` is a search suggestions URL with {searchTerms} to substitute for the search term. -**Compatibility:** Firefox ESR 60\ +**Compatibility:** Firefox ESR 60 (POST support in Firefox ESR 68)\ **CCK2 Equivalent:** `searchplugins`\ **Preferences Affected:** N/A @@ -2203,6 +2437,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\IconURL = "https://www.exa Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Alias = "example" Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description = "Example Description" Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "https://www.example.org/suggestions/q={searchTerms}" +Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\PostData = "name=value&q={searchTerms}" #### macOS ``` @@ -2226,6 +2461,8 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "http Example Description SuggestURLTemplate https://www.example.org/suggestions/q={searchTerms} + PostData + name=value&q={searchTerms} @@ -2244,6 +2481,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "http "IconURL": "https://www.example.org/favicon.ico", "Alias": "example", "Description": "Description", + "PostData": "name=value&q={searchTerms}", "SuggestURLTemplate": "https://www.example.org/suggestions/q={searchTerms}" } ] @@ -2367,6 +2605,45 @@ Software\Policies\Mozilla\Firefox\SSLVersionMin = "tls1" | "tls1.1" | "tls1.2" | } } ``` +### SupportMenu +Add a menuitem to the help menu for specifying support information. + +**Compatibility:** Firefox 68.0.1, Firefox ESR 68.0.1\ +**CCK2 Equivalent:** helpMenu\ +**Preferences Affected:** N/A + +#### Windows +``` +Software\Policies\Mozilla\Firefox\SupportMenu\Title = "Support Menu" +Software\Policies\Mozilla\Firefox\SupportMenu\URL = "http://example.com/support" +Software\Policies\Mozilla\Firefox\SupportMenu\Title = "S" +``` +#### macOS +``` + + SupportMenu + + Title + SupportMenu + URL + http://example.com/support + AccessKey + S + + +``` +### JSON +``` +{ + "policies": { + "SupportMenu": { + "Title": "Support Menu", + "URL": "http://example.com/support", + "AccessKey": "S" + } + } +} +``` ### WebsiteFilter 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.