X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/b0a2ace3c195610820723a76b900ce58239ee116..fecaac305d28ff6079dc9066814caed1756b8853:/README.md?ds=inline diff --git a/README.md b/README.md index 686be3d..bf2de26 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,6 +40,7 @@ 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. | **[`ExtensionUpdate`](#extensionupdate)** | Control extension updates. | **[`FlashPlugin`](#flashplugin)** | Configure the default Flash plugin policy as well as origins for which Flash is allowed. @@ -76,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. @@ -1104,14 +1101,14 @@ Configure DNS over HTTPS. #### Windows ``` -Software\Policies\Mozilla\Firefox\Cookies\Enabled = 0x1 | 0x0 -Software\Policies\Mozilla\Firefox\Cookies\ProviderURL = "URL_TO_ALTERNATE_PROVIDER" -Software\Policies\Mozilla\Firefox\Cookies\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Enabled = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\DNSOverHTTPS\ProviderURL = "URL_TO_ALTERNATE_PROVIDER" +Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Locked = 0x1 | 0x0 ``` #### macOS ``` - Cookies + DNSOverHTTPS Enabled | @@ -1255,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. @@ -1310,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. @@ -1979,7 +1993,7 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v #### macOS ``` - Preference + Preferences boolean_preference_name | @@ -1992,7 +2006,7 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v ``` { "policies": { - "Preference": { + "Preferences": { "boolean_preference_name": true | false, "string_preference_name": "string_value" } @@ -2053,7 +2067,7 @@ To specify ports, append them to the hostnames with a colon (:). `UseProxyForDNS` to use proxy DNS when using SOCKS v5. -**Compatibility:** Firefoox 60, Firefox ESR 60\ +**Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** `networkProxy*`\ **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` @@ -2128,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 ``` @@ -2145,6 +2165,14 @@ Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US" en-US + +or + + + RequestedLocales + de,en-US + + ``` #### JSON ``` @@ -2153,6 +2181,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. @@ -2371,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. @@ -2385,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 @@ -2399,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 ``` @@ -2422,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} @@ -2440,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}" } ] @@ -2563,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.