Merge pull request #205 from jeffreymcclain/patch-3

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 2277853e574a19074242a69c8e2848b403f29ba4..e6dbcbcaffedf2fc1052cdcec233d0ec2bc1d4ef 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-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.
+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/Contents/Resources/distribution`.  On Linux, the file goes into `firefox/distribution`, where `firefox` is the installation directory for firefox, which varies by distribution.

 
 The content of the JSON file should look like this:
 ```
 
 The content of the JSON file should look like this:
 ```


@@ -8,8 +8,14 @@ The content of the JSON file should look like this:
   }
 }
 ```
   }
 }
 ```

-Policies are documented below. Note that even though comments are used in this file for documentation, comments are not allowed for JSON files.
-### Authentication
+Policies are documented below.   
+
+
+**Note**: though comments are used in this readme file for documentation, comments are not valid in actual JSON files. Remove all comments before attempting to deploy.
+
+Some of the policies are only available on the ESR for security reasons. These policies are marked ESR only.
+
+### Authentication (ESR only)

 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
 ```
 {
 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
 ```
 {


@@ -67,7 +73,7 @@ This policy removes the "Set As Desktop Background..." menuitem when right click
 }
 ```
 ### Certificates
 }
 ```
 ### Certificates

-This is a Windows only policy that tells Firefox to read certificates from the Windows certificate store.
+If this Windows only policy is set to true, Firefox reads certificates from the Windows certificate store.

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


@@ -94,7 +100,7 @@ This policy controls various settings related to cookies.
 }
 ```
 ### DisableMasterPasswordCreation
 }
 ```
 ### DisableMasterPasswordCreation

-This policy removes the master password functionality if set to true.
+If this policy is set to true, the master password functionality is removed.

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


@@ -102,7 +108,7 @@ This policy removes the master password functionality if set to true.
   }
 }
 ```
   }
 }
 ```

-### DisableAppUpdate
+### DisableAppUpdate (ESR only)

 This policy turns off application updates.
 ```
 {
 This policy turns off application updates.
 ```
 {


@@ -130,7 +136,7 @@ This policy removes access to all developer tools.
 }
 ```
 ### DisableFeedbackCommands
 }
 ```
 ### DisableFeedbackCommands

-This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site)
+This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site).

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


@@ -139,7 +145,7 @@ This policy disables the menus for reporting sites (Submit Feedback, Report Dece
 }
 ```
 ### DisableFirefoxScreenshots
 }
 ```
 ### DisableFirefoxScreenshots

-This policy removes access to Firefox Screenshots
+This policy removes access to Firefox Screenshots.

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


@@ -148,7 +154,7 @@ This policy removes access to Firefox Screenshots
 }
 ```
 ### DisableFirefoxAccounts
 }
 ```
 ### DisableFirefoxAccounts

-This policy disables Sync
+This policy disables Sync.

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


@@ -157,16 +163,16 @@ This policy disables Sync
 }
 ```
 ### DisableFirefoxStudies
 }
 ```
 ### DisableFirefoxStudies

-This policy disables Firefox studies (Shield)
+This policy disables Firefox studies (Shield).

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

-    "DisableFirefoxAccounts": true
+    "DisableFirefoxStudies": true

   }
 }
 ```
 ### DisableForgetButton
   }
 }
 ```
 ### DisableForgetButton

-This policy disables the "Forget" button
+This policy disables the "Forget" button.

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


@@ -175,7 +181,7 @@ This policy disables the "Forget" button
 }
 ```
 ### DisableFormHistory
 }
 ```
 ### DisableFormHistory

-This policy turns off the browser.formfill.enable preferences
+This policy turns off the browser.formfill.enable preferences.

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


@@ -184,7 +190,7 @@ This policy turns off the browser.formfill.enable preferences
 }
 ```
 ### DisablePocket
 }
 ```
 ### DisablePocket

-This policy turns off Pocket
+This policy turns off Pocket.

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


@@ -193,7 +199,7 @@ This policy turns off Pocket
 }
 ```
 ### DisablePrivateBrowsing
 }
 ```
 ### DisablePrivateBrowsing

-This policy removes access to private browsing
+This policy removes access to private browsing.

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


@@ -201,6 +207,15 @@ This policy removes access to private browsing
   }
 }
 ```
   }
 }
 ```

+### DisableProfileImport
+This policy disables the "Import data from another browser" option in the bookmarks window.
+```
+{
+  "policies": {
+    "DisableProfileImport": true
+  }
+}
+```

 ### DisableProfileRefresh
 This policy disables the Refresh Firefox button on about:support and support.mozilla.org.
 ```
 ### DisableProfileRefresh
 This policy disables the Refresh Firefox button on about:support and support.mozilla.org.
 ```


@@ -211,7 +226,7 @@ This policy disables the Refresh Firefox button on about:support and support.moz
 }
 ```
 ### DisableSafeMode
 }
 ```
 ### DisableSafeMode

-This policy disables safe mode on Windows only
+This policy disables safe mode on Windows only.

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


@@ -220,7 +235,7 @@ This policy disables safe mode on Windows only
 }
 ```
 ### DisableSecurityBypass
 }
 ```
 ### DisableSecurityBypass

-This policy prevents the user from bypassign security in certain cases.
+This policy prevents the user from bypassing security in certain cases.

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


@@ -231,7 +246,7 @@ This policy prevents the user from bypassign security in certain cases.
   }
 }
 ```
   }
 }
 ```

-### DisableSystemAddonUpdate
+### DisableSystemAddonUpdate (ESR only)

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


@@ -240,8 +255,10 @@ 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.
+### DisableTelemetry (ESR only)
+This policy prevents the upload of telemetry data.
+
+Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.

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


@@ -250,7 +267,7 @@ This policy prevents the upload of telemetry data. Mozilla strongly recommends t
 }
 ```
 ### DisplayBookmarksToolbar
 }
 ```
 ### DisplayBookmarksToolbar

-This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
+This policy turns on the bookmarks toolbar by default. A user can still turn it off, and it will stay off.

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


@@ -259,7 +276,7 @@ This policy turns on the bookmarks toolbar by default. A user can still turn it
 }
 ```
 ### DisplayMenuBar
 }
 ```
 ### DisplayMenuBar

-This policy turns on the menubar by default. A user can still turn it off and it will stay off.
+This policy turns on the menubar by default. A user can still turn it off, and it will stay off.

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


@@ -279,7 +296,7 @@ This policy stops Firefox from checking if it is the default browser at startup.
 ### EnableTrackingProtection
 This policy affects tracking protection.
 
 ### 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 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 false, tracking protection is disabled and locked in both the browser and private browsing.
 


@@ -291,10 +308,11 @@ 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]
     }

+}

 ```
 ```

-### 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.
+### Extensions (ESR only)
+This policy controls the installation, uninstallation and locking of extensions. Locked extensions cannot be disabled or uninstalled.
+For Install, you specify a list of URLs or paths.

 For Uninstall and Locked, you specify extension IDs.
 ```
 {
 For Uninstall and Locked, you specify extension IDs.
 ```
 {


@@ -304,9 +322,10 @@ For Uninstall and Locked, you specify extension IDs.
       "Uninstall": ["addon_id@mozilla.org"],
       "Locked":  ["addon_id@mozilla.org"]
     }
       "Uninstall": ["addon_id@mozilla.org"],
       "Locked":  ["addon_id@mozilla.org"]
     }

+}

 ```
 ### NoDefaultBookmarks
 ```
 ### 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.
+This policy prevents the default bookmarks or the Smart Bookmarks (Most Visited, Recent Tags) from being created. Note: this policy is only effective if used before the first run of the profile.

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


@@ -323,7 +342,7 @@ This policy sets the signon.rememberSignons preference. It determines whether or
   }
 }
 ```
   }
 }
 ```

-### Homepage
+### Homepage (ESR only)

 This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
 ```
 {
 This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
 ```
 {


@@ -338,7 +357,7 @@ This policy sets the default homepage value. It can also be used to lock the hom
 }
 ```
 ### PopupBlocking
 }
 ```
 ### PopupBlocking

-This policy sets domains for which pop-up windows are allowed. It also set the default pop-up policy
+This policy sets domains for which pop-up windows are allowed. It also sets the default pop-up policy.

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


@@ -358,8 +377,8 @@ This policy sets domains that can install extensions, as well as the default beh
   "policies": {
     "InstallAddonsPermission": {
       "Allow": ["http://example.org/",
   "policies": {
     "InstallAddonsPermission": {
       "Allow": ["http://example.org/",

-                "http://example.edu/"]
-      "Default": [true|false], /* If this is set to false, add-ons cannot be installed by the user */
+                "http://example.edu/"],
+      "Default": [true|false] /* If this is set to false, add-ons cannot be installed by the user */

     }
   }
 }
     }
   }
 }


@@ -378,8 +397,8 @@ This policy sets the behavior of Flash on the specified domains, as well as the
   }
 }
 ```
   }
 }
 ```

-### OverrideFirstRunPage
-This policy allowed you to override the first run page. If you leave the URL blank, the first run page will not be displayed.
+### OverrideFirstRunPage (ESR only)
+This policy allows you to override the first run page. If you leave the URL blank, the first run page will not be displayed.

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


@@ -387,8 +406,8 @@ This policy allowed you to override the first run page. If you leave the URL bla
   }
 }
 ```
   }
 }
 ```

-### OverridePostUpdatePage
-This policy allowed you to override the upgrade page page. If you leave the URL blank, the upgrade page will not be displayed.
+### OverridePostUpdatePage (ESR only)
+This policy allows you to override the upgrade page. If you leave the URL blank, the upgrade page will not be displayed.

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


@@ -397,7 +416,7 @@ This policy allowed you to override the upgrade page page. If you leave the URL
 }
 ```
 ### Bookmarks
 }
 ```
 ### Bookmarks

-This policy allows you to specify bookmarks. You can have any number of bookmarks although only ten are specified in the ADMX file.
+This policy allows you to specify bookmarks. You can have any number of bookmarks, although only ten are specified in the ADMX file.

 Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
 same folder name are grouped together.
 
 Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
 same folder name are grouped together.
 


@@ -421,19 +440,21 @@ This policy allows you to specify proxy settings. These settings correspond to t
 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.
 ```
 {
 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]
+  "policies": {
+    "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]
+    }

   }
 }
 ```
   }
 }
 ```


@@ -446,7 +467,7 @@ If this policy is set to true,  all data is cleared when Firefox is closed. This
   }
 }
 ```
   }
 }
 ```

-### SearchBar
+### SearchBar (ESR only)

 This policy can be used to determine if the search bar is separate or combined with the URL bar.
 ```
 {
 This policy can be used to determine if the search bar is separate or combined with the URL bar.
 ```
 {


@@ -455,17 +476,19 @@ This policy can be used to determine if the search bar is separate or combined w
   }
 }
 ```
   }
 }
 ```

-### WebsiteFilter
-Blocks websites from being visited. The parameters take an array of Match Patterns, as documented in https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Match_patterns. Only http/https accesses are supported at the moment. The arrays are limited to 1000 entries each.
+### WebsiteFilter (ESR only)
+This policy blocks websites from being visited. The parameters take an array of Match Patterns, as documented in https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Match_patterns. Only http/https addresses are supported at the moment. The arrays are limited to 1000 entries each.

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

-    "Block": ["<all_urls>"],
-    "Exceptions": ["http://example.org/*"]
+    "WebsiteFilter": {
+      "Block": ["<all_urls>"],
+      "Exceptions": ["http://example.org/*"]
+    }

   }
 }
 ```
   }
 }
 ```

-### Search Engines
+### Search Engines (ESR only)

 This policy allows you to add new search engines, as well as set the default and prevent the install of search engines from web pages. Only Name and URLTemplate is required.
 ```
 {
 This policy allows you to add new search engines, as well as set the default and prevent the install of search engines from web pages. Only Name and URLTemplate is required.
 ```
 {


@@ -487,4 +510,4 @@ This policy allows you to add new search engines, as well as set the default and
     }
   }
 }
     }
   }
 }

-```
\ No newline at end of file
+```