]> git.p6c8.net - policy-templates.git/blobdiff - README.md
Merge pull request #241 from jeffreymcclain/patch-1
[policy-templates.git] / README.md
index f3a481dcaf421cc7d838926e8ce1577075ce7b85..9e21e85245a5a666924a83edba0ca2819a99443b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+**IMPORTANT**: This file is in active development along with the policies in Firefox. To get the policy information that corresponds to a specific release, go to https://github.com/mozilla/policy-templates/releases.
+
 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:
@@ -15,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".
 
-### 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.
 ```
 {
@@ -23,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"],
-      "NTLM": ["mydomain.com", "https://myotherdomain.com"]
+      "NTLM": ["mydomain.com", "https://myotherdomain.com"],
+      "AllowNonFQDN": {
+        "SPNEGO": true,
+        "NTLM": true
+      }
     }
   }
 }
@@ -73,12 +79,12 @@ This policy removes the "Set As Desktop Background..." menuitem when right click
 }
 ```
 ### 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": {
-      "ImportEnterpriseRoots": [true|false]
+      "ImportEnterpriseRoots": true
     }
   }
 }
@@ -300,7 +306,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 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": {
@@ -318,12 +324,21 @@ For Uninstall and Locked, you specify extension IDs.
 {
   "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"]
     }
 }
 ```
+### 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.
 ```
@@ -391,7 +406,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/"],
-      "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]
     }
   }
@@ -467,7 +482,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.
 ```
 {
@@ -488,8 +503,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": {
@@ -506,7 +521,42 @@ This policy allows you to add new search engines, as well as set the default and
         }
       ],
       "Default": "Name of engine",
-      "PreventInstalls": [true|false]
+      "PreventInstalls": [true|false],
+      "Remove": ["Twitter", "Wikipedia (en)"]
+    }
+  }
+}
+```
+### 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 */
+      }
     }
   }
 }

patrick-canterino.de