Merge pull request #41 from mozilla/ImportEnterpriseRoots_Policy

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 5296410c2bf1f5a90dae37ded7db76b4b6557900..07e144a46e542f6c3c95a1705ca00b01cc84ee32 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.
 ```


@@ -53,6 +66,17 @@ 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]
+    }
+  }
+}
+```

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


@@ -314,17 +338,17 @@ 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.
 ```
 ### 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 URLs with a colon (:). If Locked is set to true, the values can't be changed by the user.
+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]
 ```
 {
   "Proxy": {
     "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"]
     "Locked": [true, false]

-Z   "HTTPProxy": "URL_TO_PROXY",
+    "HTTPProxy": "hostname",

     "UseHTTPProxyForAllProtocols": [true, false]
     "UseHTTPProxyForAllProtocols": [true, false]

-    "SSLProxy": "URL_TO_PROXY",
-    "FTPProxy": "URL_TO_PROXY",
-    "SOCKSProxy": { "URL_TO_PROXY",
+    "SSLProxy": "hostname",
+    "FTPProxy": "hostname",
+    "SOCKSProxy": "hostname",

     "SOCKSVersion": [4, 5],
     "Passthrough": "List of passthrough addresses/domains",
     "AutoConfigURL": "URL_TO_AUTOCONFIG",
     "SOCKSVersion": [4, 5],
     "Passthrough": "List of passthrough addresses/domains",
     "AutoConfigURL": "URL_TO_AUTOCONFIG",