Merge pull request #110 from BergischNRW/master

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 2277853e574a19074242a69c8e2848b403f29ba4..9d358f7c0e62ed4ea620eb877a49efb4ce64fe5e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,7 +9,10 @@ The content of the JSON file should look like this:
 }
 ```
 Policies are documented below. Note that even though comments are used in this file for documentation, comments are not allowed for JSON files.
-### Authentication
+
+Some of the policies are only available on the ESR for security reasons. These policies are marked ESR only.
+
+### Authentication (ESR only)
 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
 ```
 {
@@ -102,7 +105,7 @@ This policy removes the master password functionality if set to true.
   }
 }
 ```
-### DisableAppUpdate
+### DisableAppUpdate (ESR only)
 This policy turns off application updates.
 ```
 {
@@ -161,7 +164,7 @@ This policy disables Firefox studies (Shield)
 ```
 {
   "policies": {
-    "DisableFirefoxAccounts": true
+    "DisableFirefoxStudies": true
   }
 }
 ```
@@ -201,6 +204,15 @@ This policy removes access to private browsing
   }
 }
 ```
+### DisableProfileImport
+This policy disables the"Import data from another browser" option in the bookmarks window.
+```
+{
+  "policies": {
+    "DisableProfileImport": true
+  }
+}
+```
 ### DisableProfileRefresh
 This policy disables the Refresh Firefox button on about:support and support.mozilla.org.
 ```
@@ -220,7 +232,7 @@ This policy disables safe mode on Windows only
 }
 ```
 ### DisableSecurityBypass
-This policy prevents the user from bypassign security in certain cases.
+This policy prevents the user from bypassing security in certain cases.
 ```
 {
   "policies": {
@@ -231,7 +243,7 @@ This policy prevents the user from bypassign security in certain cases.
   }
 }
 ```
-### DisableSystemAddonUpdate
+### DisableSystemAddonUpdate (ESR only)
 This policy prevents system add-ons from being updated or installed.
 ```
 {
@@ -240,8 +252,10 @@ This policy prevents system add-ons from being updated or installed.
   }
 }
 ```
-### DisableTelemetry
-This policy prevents the upload of telemetry data. Mozilla strongly recommends that you do NOT disable telemetry if you do not have a business need to do so.
+### DisableTelemetry (ESR only)
+This policy prevents the upload of telemetry data.
+
+Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
 ```
 {
   "policies": {
@@ -292,7 +306,7 @@ If Value is set to true, private browsing is enabled by default in both the brow
       "Locked": [true, false]
     }
 ```
-### Extensions
+### Extensions (ESR only)
 This policy controls the install, uninstall and locking of extensions. Locked extensions cannot be disabled or uninstalled.
 For Install, you can specify a list of URLs or paths.
 For Uninstall and Locked, you specify extension IDs.
@@ -323,7 +337,7 @@ This policy sets the signon.rememberSignons preference. It determines whether or
   }
 }
 ```
-### Homepage
+### Homepage (ESR only)
 This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
 ```
 {
@@ -358,8 +372,8 @@ This policy sets domains that can install extensions, as well as the default beh
   "policies": {
     "InstallAddonsPermission": {
       "Allow": ["http://example.org/",
-                "http://example.edu/"]
-      "Default": [true|false], /* If this is set to false, add-ons cannot be installed by the user */
+                "http://example.edu/"],
+      "Default": [true|false] /* If this is set to false, add-ons cannot be installed by the user */
     }
   }
 }
@@ -378,7 +392,7 @@ This policy sets the behavior of Flash on the specified domains, as well as the
   }
 }
 ```
-### OverrideFirstRunPage
+### OverrideFirstRunPage (ESR only)
 This policy allowed you to override the first run page. If you leave the URL blank, the first run page will not be displayed.
 ```
 {
@@ -387,7 +401,7 @@ This policy allowed you to override the first run page. If you leave the URL bla
   }
 }
 ```
-### OverridePostUpdatePage
+### OverridePostUpdatePage (ESR only)
 This policy allowed you to override the upgrade page page. If you leave the URL blank, the upgrade page will not be displayed.
 ```
 {
@@ -421,19 +435,21 @@ This policy allows you to specify proxy settings. These settings correspond to t
 To specify ports, append them to the hostnames with a colon (:). If Locked is set to true, the values can't be changed by the user.
 ```
 {
-  "Proxy": {
-    "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"]
-    "Locked": [true, false]
-    "HTTPProxy": "hostname",
-    "UseHTTPProxyForAllProtocols": [true, false]
-    "SSLProxy": "hostname",
-    "FTPProxy": "hostname",
-    "SOCKSProxy": "hostname",
-    "SOCKSVersion": [4, 5],
-    "Passthrough": "List of passthrough addresses/domains",
-    "AutoConfigURL": "URL_TO_AUTOCONFIG",
-    "AutoLogin":  [true, false],
-    "UseProxyForDNS": [true, false]
+  "policies": {
+    "Proxy": {
+      "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"],
+      "Locked": [true, false],
+      "HTTPProxy": "hostname",
+      "UseHTTPProxyForAllProtocols": [true, false],
+      "SSLProxy": "hostname",
+      "FTPProxy": "hostname",
+      "SOCKSProxy": "hostname",
+      "SOCKSVersion": [4, 5],
+      "Passthrough": "List of passthrough addresses/domains",
+      "AutoConfigURL": "URL_TO_AUTOCONFIG",
+      "AutoLogin":  [true, false],
+      "UseProxyForDNS": [true, false]
+    }
   }
 }
 ```
@@ -446,7 +462,7 @@ If this policy is set to true,  all data is cleared when Firefox is closed. This
   }
 }
 ```
-### SearchBar
+### SearchBar (ESR only)
 This policy can be used to determine if the search bar is separate or combined with the URL bar.
 ```
 {
@@ -455,17 +471,19 @@ This policy can be used to determine if the search bar is separate or combined w
   }
 }
 ```
-### WebsiteFilter
+### WebsiteFilter (ESR only)
 Blocks 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 accesses are supported at the moment. The arrays are limited to 1000 entries each.
 ```
 {
   "policies": {
-    "Block": ["<all_urls>"],
-    "Exceptions": ["http://example.org/*"]
+    "WebsiteFilter": {
+      "Block": ["<all_urls>"],
+      "Exceptions": ["http://example.org/*"]
+    }
   }
 }
 ```
-### Search Engines
+### Search Engines (ESR only)
 This policy allows you to add new search engines, as well as set the default and prevent the install of search engines from web pages. Only Name and URLTemplate is required.
 ```
 {
@@ -487,4 +505,4 @@ This policy allows you to add new search engines, as well as set the default and
     }
   }
 }
-```
\ No newline at end of file
+```