Merge pull request #46 from mozilla/DisableTelemetry_Policy

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 07e144a46e542f6c3c95a1705ca00b01cc84ee32..9de8ec98c6182fbaafcde6584225410da42cca23 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ The content of the JSON file should look like this:
   }
 }
 ```
   }
 }
 ```

-Policies are documented below.
+Policies are documented below. Note that even though comments are used in this file for documentation, comments are not allowed for JSON files.

 ### Authentication
 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
 ```
 ### Authentication
 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
 ```


@@ -77,6 +77,22 @@ This is a Windows only policy that tells Firefox to read certificates from the W
   }
 }
 ```
   }
 }
 ```

+### Cookies
+This policy controls various settings related to cookies.
+```
+{
+  "policies": {
+    "Cookies": {
+      "Allow": ["http://example.org/"], /* Domains where cookies are always allowed */
+      "Block": ["http://example.edu/"], /* Domains where cookies are always blocked */
+      "Default": [true|false], /* This sets the default value for "Accept cookies from websites" */
+      "AcceptThirdParty": ["all", "none", "from-visited"], /* This sets the default value for "Accept third-party cookies" */
+      "ExpireAtSessionEnd":  [true|false], /* This determines when cookies expire */
+      "Locked": [true|false] /* If this is true, cookies preferences can't be changed */
+    }
+  }
+}
+```

 ### CreateMasterPassword
 This policy removes the master password functionality.
 ```
 ### CreateMasterPassword
 This policy removes the master password functionality.
 ```


@@ -149,6 +165,15 @@ This policy disables Firefox studies (Shield)
   }
 }
 ```
   }
 }
 ```

+### DisableForgetButton
+This policy disables the "Forget" button
+```
+{
+  "policies": {
+    "DisableForgetButton": true
+  }
+}
+```

 ### DisableFormHistory
 This policy turns off the browser.formfill.enable preferences
 ```
 ### DisableFormHistory
 This policy turns off the browser.formfill.enable preferences
 ```


@@ -176,6 +201,15 @@ This policy removes access to private browsing
   }
 }
 ```
   }
 }
 ```

+### DisableProfileRefresh
+This policy disables the Refresh Firefox button on about:support and support.mozilla.org.
+```
+{
+  "policies": {
+    "DisableProfileRefresh": true
+  }
+}
+```

 ### DisableSafeMode
 This policy disables safe mode on Windows only
 ```
 ### DisableSafeMode
 This policy disables safe mode on Windows only
 ```


@@ -185,6 +219,18 @@ This policy disables safe mode on Windows only
   }
 }
 ```
   }
 }
 ```

+### DisableSecurityBypass
+This policy prevents the user from bypassign security in certain cases.
+```
+{
+  "policies": {
+    "DisableSecurityBypass": {
+      "InvalidCertificate": [true|false], /* Prevents adding an exception when an invalid certificate is shown */
+      "SafeBrowsing": [true|false]        /* Prevents selecting "ignore the risk" and visiting a harmful site anyway */
+    }
+  }
+}
+```

 ### DisableSysAddonUpdate
 This policy prevents system add-ons from being updated or installed.
 ```
 ### DisableSysAddonUpdate
 This policy prevents system add-ons from being updated or installed.
 ```


@@ -194,6 +240,15 @@ 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.
+```
+{
+  "policies": {
+    "DisableTelemetry": true
+  }
+}
+```

 ### DisplayBookmarksToolbar
 This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
 ```
 ### DisplayBookmarksToolbar
 This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
 ```


@@ -293,18 +348,6 @@ This policy sets domains that can install extensions
   }
 }
 ```
   }
 }
 ```

-### Cookies
-This policy sets domains that can set or not set cookies.
-```
-{
-  "policies": {
-    "Cookies": {
-      "Allow": ["http://example.org/"],
-      "Block": ["http://example.edu/"]
-    }
-  }
-}
-```

 ### FlashPlugin
 This policy sets domains that can use or not use Flash
 ```
 ### FlashPlugin
 This policy sets domains that can use or not use Flash
 ```