Merge pull request #40 from mozilla/Authentication_policy

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index b6d3bc6db6e1d11da85fe7aca609ed7bf02edbd0..867fb97055c238d993b3bbd55a65b0d9b1bcfa4c 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:
 ```
 {
@@ -8,7 +9,19 @@ The content of the JSON file should look like this:
 }
 ```
 Policies are documented below.
-
+### 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.
 ```
@@ -27,6 +40,15 @@ This policy removes access to about:config.
   }
 }
 ```
+### BlockAboutProfiles
+This policy removes access to about:profiles.
+```
+{
+  "policies": {
+    "BlockAboutProfiles": true
+  }
+}
+```
 ### BlockAboutSupport
 This policy removes access to about:support.
 ```
@@ -188,6 +210,31 @@ This policy stops Firefox from checking if it is the default browser at startup.
   }
 }
 ```
+### EnableTrackingProtection
+This policy affects tracking protection.
+
+If this policy is not configured, tracking protection is not enabled by default in the browser but it is enabled by default in private browsing and the user can change it.
+
+If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing.
+
+If Value is set to true, private browsing is enabled by default in both the browser and private browsing and you can choose set the Locked value if you want to prevent the user from changing it.
+```
+{
+  "policies": {
+    "EnableTrackingProtection": {
+      "Value": [true, false],
+      "Locked": [true, false]
+    }
+```
+### NoDefaultBookmarks
+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": {
+    "NoDefaultBookmarks": true
+  }
+}
+```
 ### RememberPasswords
 This policy sets the signon.rememberSignons preference. It can either be enabled or disabled.
 ```
@@ -271,10 +318,31 @@ same folder name are grouped together.
     {"Title": "Example",
      "URL": "http://example.org",
      "Favicon": "http://example.com/favicon.ico",
-     "Placement": "toolbar",
-     "Folder": "Bookmarks"
+     "Placement": ["toolbar", "menu"],
+     "Folder": "FolderName"
      }
     ]
   }
 }
 ```
+### 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]
+  }
+}
+```