Merge pull request #406 from MS-PC/patch-2

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 0160a0b8febed15856974792421748b4cf330883..0143b5a1df67d8743e78f43aafd0ce6f69acec74 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +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.
 **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.


@@ -44,6 +42,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.
 | **[`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.
 | **[`Extensions`](#extensions)** | Control the installation, uninstallation and locking of extensions.
 | **[`ExtensionSettings`](#extensionsettings)** | Manage all aspects of extensions.
 | **[`ExtensionUpdate`](#extensionupdate)** | Control extension updates.


@@ -1256,6 +1255,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.
 
 ### Extensions
 Control the installation, uninstallation and locking of extensions.
 


@@ -1368,7 +1381,7 @@ Due to a bug in Firefox 68, this policy is not working via GPO on Windows. We wi
 ```
 {
   "policies": {
 ```
 {
   "policies": {

-    "ExtensionsSettings": {
+    "ExtensionSettings": {

       "*": {
         "blocked_install_message": "Custom error message.",
         "install_sources": ["https://addons.mozilla.org/"],
       "*": {
         "blocked_install_message": "Custom error message.",
         "install_sources": ["https://addons.mozilla.org/"],


@@ -2052,7 +2065,7 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v
 #### macOS
 ```
 <dict>
 #### macOS
 ```
 <dict>

-  <key>Preference</key>
+  <key>Preferences</key>

   <dict>
     <key>boolean_preference_name</key>
     <true/> | <false/>
   <dict>
     <key>boolean_preference_name</key>
     <true/> | <false/>


@@ -2065,7 +2078,7 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v
 ```
 {
   "policies": {
 ```
 {
   "policies": {

-    "Preference": {
+    "Preferences": {

       "boolean_preference_name": true | false,
       "string_preference_name": "string_value"
     }
       "boolean_preference_name": true | false,
       "string_preference_name": "string_value"
     }


@@ -2201,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.
 
 ### 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"
 **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
 ```
 ```
 #### macOS
 ```


@@ -2218,6 +2237,14 @@ Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US"
     <string>en-US</string>
   </array>
 </dict>
     <string>en-US</string>
   </array>
 </dict>

+
+or
+
+<dict>
+  <key>RequestedLocales</key>
+  <string>de,en-US</string>
+</dict>
+

 ```
 #### JSON
 ```
 ```
 #### JSON
 ```


@@ -2226,6 +2253,14 @@ Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US"
     "RequestedLocales": ["de", "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.
 ```
 ### 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.


@@ -2444,7 +2479,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
 ```
 ### SearchEngines | Add
 
 ```
 ### 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.
 
 
 `Name` is the name of the search engine.
 


@@ -2458,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.
 
 
 `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.
 
 `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
 
 **CCK2 Equivalent:** `searchplugins`\
 **Preferences Affected:** N/A
 


@@ -2472,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\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
 ```
 
 #### macOS
 ```


@@ -2495,6 +2533,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>
         <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>
       </dict>
     <array>
   </dict>


@@ -2513,6 +2553,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "http
           "IconURL": "https://www.example.org/favicon.ico",
           "Alias": "example",
           "Description": "Description",
           "IconURL": "https://www.example.org/favicon.ico",
           "Alias": "example",
           "Description": "Description",

+          "PostData": "name=value&q={searchTerms}",

           "SuggestURLTemplate": "https://www.example.org/suggestions/q={searchTerms}"
         }
       ]
           "SuggestURLTemplate": "https://www.example.org/suggestions/q={searchTerms}"
         }
       ]