Merge pull request #40 from mozilla/Authentication_policy

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 9062eedaa978290fb7c2ba22f0b9b7e8470874c4..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:
 ```
 {
 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.
 }
 ```
 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.
 ```
 ### BlockAboutAddons
 This policy removes access to about:addons.
 ```


@@ -214,7 +227,7 @@ If Value is set to true, private browsing is enabled by default in both the brow
     }
 ```
 ### NoDefaultBookmarks
     }
 ```
 ### 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": {
 ```
 {
   "policies": {


@@ -222,15 +235,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.
 ```
 ### RememberPasswords
 This policy sets the signon.rememberSignons preference. It can either be enabled or disabled.
 ```


@@ -321,3 +325,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]
+  }
+}
+```