Additional Bookmark Policies

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 64a8602bfea2e7207ffc8382b2b92102d13e26a0..329cb8dcf6961386dcc9bd526ecd8861fed89928 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.
 ```
 {


@@ -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.
 ```
 {


@@ -161,7 +167,7 @@ This policy disables Firefox studies (Shield)
 ```
 {
   "policies": {
 ```
 {
   "policies": {

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

   }
 }
 ```
   }
 }
 ```


@@ -229,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": {


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


@@ -249,7 +255,7 @@ This policy prevents system add-ons from being updated or installed.
   }
 }
 ```
   }
 }
 ```

-### DisableTelemetry
+### 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.
 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.


@@ -302,8 +308,9 @@ 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
+### Extensions (ESR only)

 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.
 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.


@@ -315,6 +322,7 @@ 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
 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.
 ```
 ### 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.


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


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

-### OverrideFirstRunPage
+### OverrideFirstRunPage (ESR only)

 This policy allowed you to override the first run page. If you leave the URL blank, the first run page will not be displayed.
 ```
 {
 This policy allowed you to override the first run page. If you leave the URL blank, the first run page will not be displayed.
 ```
 {


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

-### OverridePostUpdatePage
+### OverridePostUpdatePage (ESR only)

 This policy allowed you to override the upgrade page page. If you leave the URL blank, the upgrade page will not be displayed.
 ```
 {
 This policy allowed you to override the upgrade page page. If you leave the URL blank, the upgrade page will not be displayed.
 ```
 {


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


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

-### WebsiteFilter
+### WebsiteFilter (ESR only)

 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.
 ```
 {
 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.
 ```
 {


@@ -480,7 +488,7 @@ Blocks websites from being visited. The parameters take an array of Match Patter
   }
 }
 ```
   }
 }
 ```

-### 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.
 ```
 {