Merge pull request #48 from mozilla/FlashPlugin_Policy

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index c263320b4dc7f04d9783949a2bcd742c8fd29325..b8a949a131e8fd20faf9a85c261646a66c751221 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:
 ```
 {


@@ -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.
 ```
 ### 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.
 ```
 ### 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
 ```
 ### 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
 ```
 ### DisableSafeMode
 This policy disables safe mode on Windows only
 ```


@@ -161,6 +219,18 @@ This policy disables safe mode on Windows only
   }
 }
 ```
   }
 }
 ```

+### DisableSecurityBypass
+This policy prevents the user from bypassign security in certain cases.
+```
+{
+  "policies": {
+    "DisableSecurityBypass": {
+      "InvalidCertificate": [true|false], /* Prevents adding an exception when an invalid certificate is shown */
+      "SafeBrowsing": [true|false]        /* Prevents selecting "ignore the risk" and visiting a harmful site anyway */
+    }
+  }
+}
+```

 ### 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 +240,15 @@ This policy prevents system add-ons from being updated or installed.
   }
 }
 ```
   }
 }
 ```

+### DisableTelemetry
+This policy prevents the upload of telemetry data. Mozilla strongly recommends that you do NOT disable telemetry if you do not have a business need to do so.
+```
+{
+  "policies": {
+    "DisableTelemetry": true
+  }
+}
+```

 ### DisplayBookmarksToolbar
 This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
 ```
 ### DisplayBookmarksToolbar
 This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
 ```


@@ -212,21 +291,26 @@ If Value is set to true, private browsing is enabled by default in both the brow
       "Value": [true, false],
       "Locked": [true, false]
     }
       "Value": [true, false],
       "Locked": [true, false]
     }

-### NoDefaultBookmarks
-Don't create the default bookmarks. Note: this policy is only effective if used before the first run of the profile.
+```
+### Extensions
+This policy controls the install, uninstall and locking of extensions. Locked extensions cannot be disabled or uninstalled.
+For Install, you can specify a list of URLs or paths.
+For Uninstall and Locked, you specify extension IDs.

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

-    "NoDefaultBookmarks": true
-  }
-}
+    "Extensions": {
+      "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"]
+      "Uninstall": ["addon_id@mozilla.org"],
+      "Locked":  ["addon_id@mozilla.org"]
+    }

 ```
 ```

-### NoSmartBookmarks
-Remove the Smart Bookmarks (Most Visited, Recent Tags)
+### 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": {
 ```
 {
   "policies": {

-    "NoSmartBookmarks": true
+    "NoDefaultBookmarks": true

   }
 }
 ```
   }
 }
 ```


@@ -277,26 +361,16 @@ 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
 ### FlashPlugin

-This policy sets domains that can use or not use Flash
+This policy sets the behavior of Flash on the specified domains, as well as the default behavior.

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

-      "Allow": ["http://example.org/"],
-      "Block": ["http://example.edu/"]
+      "Allow": ["http://example.org/"], /* Sites on the allow list do not override Flash being completely disabled */
+      "Block": ["http://example.edu/"],
+      "Default": [true|false], /* If this is set to true, flash is always enabled. If it is set to false, Flash is never enabled */
+      "Locked": [true|false]

     }
   }
 }
     }
   }
 }


@@ -320,3 +394,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]
+  }
+}
+```