WebsiteFilter snippet needs policy name 'WebsiteFilter'

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index a769b7311bf8afdddb2296a1ccfb2fa7fdb0f70a..baf14b7ea58251fd1361b8c1d883315ee01a0e58 100644 (file)
--- a/README.md
+++ b/README.md
@@ -86,19 +86,19 @@ This policy controls various settings related to 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" */
       "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" */
+      "AcceptThirdParty": ["always", "never", "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 */
     }
   }
 }
 ```
       "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.
+### DisableMasterPasswordCreation
+This policy removes the master password functionality if set to true.

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

-    "CreateMasterPassword": false
+    "DisableMasterPasswordCreation": [true|false]

   }
 }
 ```
   }
 }
 ```


@@ -201,6 +201,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.
 ```


@@ -231,17 +240,19 @@ This policy prevents the user from bypassign security in certain cases.
   }
 }
 ```
   }
 }
 ```

-### DisableSysAddonUpdate
+### DisableSystemAddonUpdate

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

-    "DisableSysAddonUpdate": true
+    "DisableSystemAddonUpdate": true

   }
 }
 ```
 ### DisableTelemetry
   }
 }
 ```
 ### 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.
+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": {


@@ -314,12 +325,12 @@ Don't create the default bookmarks or the Smart Bookmarks (Most Visited, Recent
   }
 }
 ```
   }
 }
 ```

-### RememberPasswords
-This policy sets the signon.rememberSignons preference. It can either be enabled or disabled.
+### OfferToSaveLogins
+This policy sets the signon.rememberSignons preference. It determines whether or not Firefox offers to save passwords. It can either be enabled or disabled.

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

-    "RememberPasswords": true
+    "OfferToSaveLogins": true

   }
 }
 ```
   }
 }
 ```


@@ -351,12 +362,12 @@ This policy sets domains for which pop-up windows are allowed. It also set the d
   }
 }
 ```
   }
 }
 ```

-### InstallAddons
+### InstallAddonsPermission

 This policy sets domains that can install extensions, as well as the default behavior.
 ```
 {
   "policies": {
 This policy sets domains that can install extensions, as well as the default behavior.
 ```
 {
   "policies": {

-    "InstallAddons": {
+    "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 */
       "Allow": ["http://example.org/",
                 "http://example.edu/"]
       "Default": [true|false], /* If this is set to false, add-ons cannot be installed by the user */


@@ -405,12 +416,13 @@ same folder name are grouped together.
 {
   "policies": {
     "Bookmarks": [
 {
   "policies": {
     "Bookmarks": [

-    {"Title": "Example",
-     "URL": "http://example.org",
-     "Favicon": "http://example.com/favicon.ico",
-     "Placement": ["toolbar", "menu"],
-     "Folder": "FolderName"
-     }
+      {
+        "Title": "Example",
+        "URL": "http://example.org",
+        "Favicon": "http://example.com/favicon.ico",
+        "Placement": ["toolbar", "menu"],
+        "Folder": "FolderName"
+      }

     ]
   }
 }
     ]
   }
 }


@@ -454,3 +466,38 @@ 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.
+```
+{
+  "policies": {
+    "WebsiteFilter": {
+      "Block": ["<all_urls>"],
+      "Exceptions": ["http://example.org/*"]
+    }
+  }
+}
+```
+### Search Engines
+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.
+```
+{
+  "policies": {
+    "SearchEngines": {
+      "Add": [
+        {
+          "Name": "",
+          "URLTemplate": "URL including {searchTerms} to substitute for the terms",
+          "Method": ["GET", "POST"],
+          "IconURL": "URL to icon",
+          "Alias": "Alias that can be used to access the engine",
+          "Description": "Description",
+          "SuggestURLTemplate": "URL for suggestions using {searchTerms}"
+        }
+      ],
+      "Default": "Name of engine",
+      "PreventInstalls": [true|false]
+    }
+  }
+}
+```