X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/cda9c267fccc61741d531352cb912498e2a64d58..895f323b15797b064451ed707156cf724af85597:/README.md

diff --git a/README.md b/README.md
index 02300dc..ad34f1d 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
@@ -42,9 +40,11 @@ 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.
+| **[`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.
@@ -73,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.
@@ -1101,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
 ```
 <dict>
-  <key>Cookies</key>
+  <key>DNSOverHTTPS</key>
   <dict>
     <key>Enabled</key>
     <true/> | <false/>
@@ -1177,13 +1177,20 @@ Software\Policies\Mozilla\Firefox\DefaultDownloadDirectory = "${home}\Downloads"
   <string>${home}/Downloads</string>
 </dict>
 ```
-#### JSON
+#### JSON (macOS and Linux)
 ```
 {
   "policies": {
     "DefaultDownloadDirectory": "${home}/Downloads"
 }
 ```
+#### JSON (Windows)
+```
+{
+  "policies": {
+    "DefaultDownloadDirectory": "${home}\\Downloads"
+}
+```
 ### DownloadDirectory
 Set and lock the download directory.
 
@@ -1204,13 +1211,20 @@ Software\Policies\Mozilla\Firefox\DownloadDirectory = "${home}\Downloads"
   <string>${home}/Downloads</string>
 </dict>
 ```
-#### JSON
+#### JSON (macOS and Linux)
 ```
 {
   "policies": {
     "DownloadDirectory": "${home}/Downloads"
 }
 ```
+#### JSON (Windows)
+```
+{
+  "policies": {
+    "DownloadDirectory": "${home}\\Downloads"
+}
+```
 ### EnableTrackingProtection
 Configure tracking protection.
 
@@ -1252,6 +1266,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
+```
+<dict>
+  <key>EnterprisePoliciesEnabled</key>
+  <true/>
+</dict>
+```
 ### Extensions
 Control the installation, uninstallation and locking of extensions.
 
@@ -1307,6 +1335,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.
 
@@ -1388,6 +1419,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
+```
+<dict>
+  <key>FirefoxHome</key>
+  <dict>
+    <key>Search</key>
+    <true/> | <false/>
+    <key>TopSites</key>
+    <true/> | <false/>
+    <key>Highlights</key>
+    <true/> | <false/>
+    <key>Pocket</key>
+    <true/> | <false/>
+    <key>Snippets</key>
+    <true/> | <false/>
+    <key>Locked</key>
+    <true/> | <false/>
+  </dict>
+</dict>
+```
+#### 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.
 
@@ -1925,7 +2007,7 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v
 #### macOS
 ```
 <dict>
-  <key>Preference</key>
+  <key>Preferences</key>
   <dict>
     <key>boolean_preference_name</key>
     <true/> | <false/>
@@ -1938,7 +2020,7 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v
 ```
 {
   "policies": {
-    "Preference": {
+    "Preferences": {
       "boolean_preference_name": true | false,
       "string_preference_name": "string_value"
     }
@@ -1999,7 +2081,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`
 
@@ -2074,13 +2156,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
 ```
@@ -2091,6 +2179,14 @@ Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US"
     <string>en-US</string>
   </array>
 </dict>
+
+or
+
+<dict>
+  <key>RequestedLocales</key>
+  <string>de,en-US</string>
+</dict>
+
 ```
 #### JSON
 ```
@@ -2099,6 +2195,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.
@@ -2317,7 +2421,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.
 
@@ -2331,9 +2435,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
 
@@ -2345,6 +2451,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
 ```
@@ -2368,6 +2475,8 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "http
         <string>Example Description</string>
         <key>SuggestURLTemplate</key>
         <string>https://www.example.org/suggestions/q={searchTerms}</string>
+        <key>PostData</key>
+        <string>name=value&q={searchTerms}</string>
       </dict>
     <array>
   </dict>
@@ -2386,6 +2495,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}"
         }
       ]
@@ -2509,6 +2619,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
+```
+<dict>
+  <key>SupportMenu</key>
+  <dict>
+    <key>Title</key>
+    <string>SupportMenu</string>
+    <key>URL</key>
+    <string>http://example.com/support</string>
+    <key>AccessKey</key>
+    <string>S</string>
+  </dict>
+</dict>
+```
+### 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.