X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/e3882b404aaa64953c32ab5a0d04d4dfa84cf8ae..b3ba0ef2b91e66a5c8dee230895fe3df87f4574d:/README.md diff --git a/README.md b/README.md index 5ac4b39..eb804a7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,3 @@ -**IMPORTANT**: **Complete Firefox 68 policies will be released later today.** - -**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 @@ -44,9 +40,12 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`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. +| **[`ExtensionSettings`](#extensionsettings)** | Manage all aspects 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. @@ -75,9 +74,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. @@ -1254,6 +1253,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. @@ -1309,6 +1322,80 @@ Software\Policies\Mozilla\Firefox\Extensions\Locked\1 = "addon_id@mozilla.org" } } ``` +### ExtensionSettings +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. + +This policy maps an extension ID to its configuration. With an extension ID, 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. + +To obtain an extension ID, install the extension and go to about:support. You will see the ID in the Extensions section. + +The configuration for each extension is another dictionary that can contain the fields documented below. + +| Name | Description | +| --- | --- | +| `installation_mode` | Maps to a string indicating the installation mode for the extension. The valid strings are `allowed`,`blocked`,`force_installed`, and `normal_installed`. +|         `allowed` | Allows the extension to be installed by the user. This is the default behavior. +|         `blocked`| Blocks installation of the extension and removes it from the device if already installed. +|         `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. +|         `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. +| `install_url`| Maps to a string 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 +| `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. +| `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. +| `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. + +**Compatibility:** Firefox 68, Firefox ESR 68, Firefox 68.0.1 (Windows)\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows +Currently, you have to remove all newlines from your JSON. We will be removing that limitation in a future release. + +Software\Policies\Mozilla\Firefox\ExtensionSettings = '{"*": {"installation_mode": "blocked"}}` +#### macOS +``` + + ExtensionSettings + + * + + blocked_install_message + Custom error message. + install_sources + + https://addons.mozilla.org/ + + installation_mode + blocked + + uBlock0@raymondhill.net + + installation_mode + force_installed + install_url + https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi + + + +``` +#### JSON +``` +{ + "policies": { + "ExtensionSettings": { + "*": { + "blocked_install_message": "Custom error message.", + "install_sources": ["https://addons.mozilla.org/"], + "installation_mode": "blocked" + }, + "uBlock0@raymondhill.net": { + "installation_mode": "force_installed", + "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi" + } + } + } +} +``` + ### ExtensionUpdate Control extension updates. @@ -1390,6 +1477,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. @@ -1927,7 +2065,7 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v #### macOS ``` - Preference + Preferences boolean_preference_name | @@ -1940,7 +2078,7 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v ``` { "policies": { - "Preference": { + "Preferences": { "boolean_preference_name": true | false, "string_preference_name": "string_value" } @@ -2076,13 +2214,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 ``` @@ -2093,6 +2237,14 @@ Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US" en-US + +or + + + RequestedLocales + de,en-US + + ``` #### JSON ``` @@ -2101,6 +2253,14 @@ 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. @@ -2319,7 +2479,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. @@ -2333,9 +2493,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 @@ -2347,6 +2509,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 ``` @@ -2370,6 +2533,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} @@ -2388,6 +2553,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}" } ] @@ -2511,6 +2677,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.