Merge pull request #44 from mozilla/DisableProfileRefresh_Policy

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 9062eedaa978290fb7c2ba22f0b9b7e8470874c4..1282d8cddaab5ba4b8cdfa35ea4a43769992ff7c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
-Policies can either be specified using the GPO templates or by putting a file called policies.json in the distribution directory.
+Policies can either be specified using the Group Policy templates 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/Content/Resources/distribution.
+
 The content of the JSON file should look like this:
 ```
 {
@@ -7,8 +8,20 @@ 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.
+```
+{
+  "policies": {
+    "Authentication": {
+      "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
+      "Delegated": ["mydomain.com", "https://myotherdomain.com"],
+      "NTLM": ["mydomain.com", "https://myotherdomain.com"]
+    }
+  }
+}
+```
 ### BlockAboutAddons
 This policy removes access to about:addons.
 ```
@@ -53,6 +66,33 @@ This policy removes the "Set As Desktop Background..." menuitem when right click
   }
 }
 ```
+### Certificates
+This is a Windows only policy that tells Firefox to read certificates from the Windows certificate store.
+```
+{
+  "policies": {
+    "Certificates": {
+      "ImportEnterpriseRoots": [true|false]
+    }
+  }
+}
+```
+### 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.
 ```
@@ -125,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
 ```
@@ -152,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
 ```
@@ -214,7 +272,7 @@ If Value is set to true, private browsing is enabled by default in both the brow
     }
 ```
 ### NoDefaultBookmarks
-Don't create the default bookmarks. Note: this policy is only effective if used before the first run of the profile.
+Don't create the default bookmarks or the Smart Bookmarks (Most Visited, Recent Tags). Note: this policy is only effective if used before the first run of the profile.
 ```
 {
   "policies": {
@@ -222,15 +280,6 @@ Don't create the default bookmarks. Note: this policy is only effective if used
   }
 }
 ```
-### NoSmartBookmarks
-Remove the Smart Bookmarks (Most Visited, Recent Tags)
-```
-{
-  "policies": {
-    "NoSmartBookmarks": true
-  }
-}
-```
 ### RememberPasswords
 This policy sets the signon.rememberSignons preference. It can either be enabled or disabled.
 ```
@@ -278,18 +327,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
 ```
@@ -321,3 +358,24 @@ same folder name are grouped together.
   }
 }
 ```
+### Proxy
+This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
+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]
+  }
+}
+```