Merge pull request #273 from mozilla/fix_l10n_bookmarks

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 4b9cfc983cadd2e9413dd1713468edcdb390fab1..08f5816c0af0bcd2f4fa62833f11f32ce6f8e12d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ Policies are documented below.
 
 Some of the policies were originally only available on the ESR for security reasons. As of Firefox 62, these policies are available outside of the ESR, but only via JSON file or a Local Machine-based Group Policy. User-based Group Policies are not allowed to set values for these policies. The descriptions below mark such policies as "Machine only".
 
 
 Some of the policies were originally only available on the ESR for security reasons. As of Firefox 62, these policies are available outside of the ESR, but only via JSON file or a Local Machine-based Group Policy. User-based Group Policies are not allowed to set values for these policies. The descriptions below mark such policies as "Machine only".
 

-### Authentication (Machine only)
+### 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.
 ```
 {
 This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information.
 ```
 {


@@ -25,7 +25,11 @@ This policy is for configuring sites that support integrated authentication. See
     "Authentication": {
       "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
       "Delegated": ["mydomain.com", "https://myotherdomain.com"],
     "Authentication": {
       "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
       "Delegated": ["mydomain.com", "https://myotherdomain.com"],

-      "NTLM": ["mydomain.com", "https://myotherdomain.com"]
+      "NTLM": ["mydomain.com", "https://myotherdomain.com"],
+      "AllowNonFQDN": {
+        "SPNEGO": true,
+        "NTLM": true
+      }

     }
   }
 }
     }
   }
 }


@@ -65,22 +69,32 @@ This policy removes access to about:support.
     "BlockAboutSupport": true
 }
 ```
     "BlockAboutSupport": true
 }
 ```

-### DisableSetDesktopBackground
-This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
+### Bookmarks
+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.

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

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

   }
 }
 ```
 ### Certificates
   }
 }
 ```
 ### Certificates

-If this Windows only policy is set to true, Firefox reads certificates from the Windows certificate store.
+If this policy is set to any value, Firefox reads certificates from the system certificate store. This is currently only supported on Windows, but will be available on macOS with Firefox 63.

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

-      "ImportEnterpriseRoots": [true|false]
+      "ImportEnterpriseRoots": true

     }
   }
 }
     }
   }
 }


@@ -101,6 +115,28 @@ This policy controls various settings related to cookies.
   }
 }
 ```
   }
 }
 ```

+### DNSOverHTTPS
+This policy configures DNS over HTTPS.
+```
+{
+  "policies": {
+    "DNSOverHTTPS": {
+      "Enabled": [true|false],
+      "ProviderURL": "URL_TO_ALTERNATE_PROVIDER",
+      "Locked": [true|false]
+    }
+  }
+}
+```
+### DisableSetDesktopBackground
+This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
+```
+{
+  "policies": {
+    "DisableSetDesktopBackground": true
+  }
+}
+```

 ### DisableMasterPasswordCreation
 If this policy is set to true, the master password functionality is removed.
 ```
 ### DisableMasterPasswordCreation
 If this policy is set to true, the master password functionality is removed.
 ```


@@ -302,7 +338,7 @@ If this policy is not configured, tracking protection is not enabled by default
 
 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.
 

-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.
+If Value is set to true, tracking protection 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": {
 ```
 {
   "policies": {


@@ -320,12 +356,21 @@ For Uninstall and Locked, you specify extension IDs.
 {
   "policies": {
     "Extensions": {
 {
   "policies": {
     "Extensions": {

-      "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"]
+      "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"],

       "Uninstall": ["addon_id@mozilla.org"],
       "Locked":  ["addon_id@mozilla.org"]
     }
 }
 ```
       "Uninstall": ["addon_id@mozilla.org"],
       "Locked":  ["addon_id@mozilla.org"]
     }
 }
 ```

+### HardwareAcceleration
+This policy disables hardware acceleration by locking the preference layers.acceleration.disabled to true.
+```
+{
+  "policies": {
+    "HardwareAcceleration": false
+  }
+}
+```

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


@@ -393,7 +438,7 @@ This policy sets the behavior of Flash on the specified domains, as well as the
     "FlashPlugin": {
       "Allow": ["http://example.org/"], /* Sites on the allow list do not override Flash being completely disabled */
       "Block": ["http://example.edu/"],
     "FlashPlugin": {
       "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 */
+      "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]
     }
   }
       "Locked": [true|false]
     }
   }


@@ -417,23 +462,37 @@ This policy allows you to override the upgrade page. If you leave the URL blank,
   }
 }
 ```
   }
 }
 ```

-### Bookmarks
-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.
-
-```
-{
-  "policies": {
-    "Bookmarks": [
-      {
-        "Title": "Example",
-        "URL": "http://example.org",
-        "Favicon": "http://example.com/favicon.ico",
-        "Placement": ["toolbar", "menu"],
-        "Folder": "FolderName"
+### Permissions
+This policy allows you to change the permissions associated with camera, microphone, location, and notifications
+```
+{
+  "policies": {
+    "Permissions": {
+      "Camera": {
+        "Allow": ["http://example.org/"], /* Origins where camera access is allowed by default */
+        "Block": ["http://example.org/"], /* Origins where camera access is blocked by default */
+        "BlockNewRequests": [true|false], /* Block new requests to access the camera */
+        "Locked": [true|false] /* Don't allow the user to change the camera preferences */
+      },
+      "Microphone": {
+        "Allow": ["http://example.org/"], /* Origins where microphone access is allowed by default */
+        "Block": ["http://example.org/"], /* Origins where microphone access  is blocked by default */
+        "BlockNewRequests": [true|false], /* Block new requests to access the microphone */
+        "Locked": [true|false] /* Don't allow the user to change the microphone preferences */
+      },
+      "Location": {
+        "Allow": ["http://example.org/"], /* Origins where location access is allowed by default */
+        "Block": ["http://example.org/"], /* Origins where location access is blocked by default */
+        "BlockNewRequests": [true|false], /* Block new requests to access location */
+        "Locked": [true|false] /* Don't allow the user to change the location preferences */
+      },
+      "Notifications": {
+        "Allow": ["http://example.org/"], /* Origins where sending notifications is allowed by default */
+        "Block": ["http://example.org/"], /* Origins where sending notifications is blocked by default */
+        "BlockNewRequests": [true|false], /* Block new requests to send notifications */
+        "Locked": [true|false] /* Don't allow the user to change the notification preferences */

       }
       }

-    ]
+    }

   }
 }
 ```
   }
 }
 ```


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

-### SearchBar (Machine only)
+### SearchBar

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


@@ -490,8 +549,8 @@ This policy blocks websites from being visited. The parameters take an array of
   }
 }
 ```
   }
 }
 ```

-### Search Engines (Machine 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.
+### Search Engines (This policy is only available on the ESR.)
+This policy allows you to add new search engines, remove or hide 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": {
 ```
 {
   "policies": {


@@ -508,7 +567,8 @@ This policy allows you to add new search engines, as well as set the default and
         }
       ],
       "Default": "Name of engine",
         }
       ],
       "Default": "Name of engine",

-      "PreventInstalls": [true|false]
+      "PreventInstalls": [true|false],
+      "Remove": ["Twitter", "Wikipedia (en)"]

     }
   }
 }
     }
   }
 }