Merge pull request #41 from mozilla/ImportEnterpriseRoots_Policy

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 1d81e0e5173b5add3e76215022b24100dd1ba708..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.
 ```


@@ -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.
 ```
 ### BlockAboutSupport
 This policy removes access to about:support.
 ```


@@ -44,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.
 ```


@@ -62,12 +95,12 @@ This policy turns off application updates.
   }
 }
 ```
   }
 }
 ```

-### DisableDeveloperTools
-This policy removes access to all developer tools.
+### DisableBuiltinPDFViewer
+This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.

 ```
 {
   "policies": {
 ```
 {
   "policies": {

-    "DisableDeveloperTools": true
+    "DisableBuiltinPDFViewer": true

   }
 }
 ```
   }
 }
 ```


@@ -80,6 +113,15 @@ This policy removes access to all developer tools.
   }
 }
 ```
   }
 }
 ```

+### DisableFeedbackCommands
+This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site)
+```
+{
+  "policies": {
+    "DisableFeedbackCommands": true
+  }
+}
+```

 ### DisableFirefoxScreenshots
 This policy removes access to Firefox Screenshots
 ```
 ### DisableFirefoxScreenshots
 This policy removes access to Firefox Screenshots
 ```


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

+### DisableSafeMode
+This policy disables safe mode on Windows only
+```
+{
+  "policies": {
+    "DisableSafeMode": true
+  }
+}
+```

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


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


@@ -253,10 +329,31 @@ same folder name are grouped together.
     {"Title": "Example",
      "URL": "http://example.org",
      "Favicon": "http://example.com/favicon.ico",
     {"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]
+  }
+}
+```