Update firefox.adml

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 4dcd1e86118e2b6800d5dcfb7850d3e860730400..34ffce1690a5a34c78912c72697f918259041fe2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 **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.
 
 **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.
+Policies can be specified using the Group Policy templates on Windows (https://github.com/mozilla/policy-templates/tree/master/windows), configuration profiles on macOS (https://github.com/mozilla/policy-templates/tree/master/mac), 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:
 ```


@@ -15,7 +15,14 @@ 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.
 
 
 **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 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".
+### AppUpdateURL
+This policy is for changing the URL used for application update
+```
+{
+  "AppUpdateURL": "http://yoursite.com"
+}
+```
+

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


@@ -69,22 +76,67 @@ 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"
+      }
+    ]

   }
 }
 ```
   }
 }
 ```

+### CaptivePortal
+This policy enables or disables captive portal support by setting and locking the preference `network.captive-portal-service.enabled`.
+```
+{
+  "policies": {
+    "CaptivePortal": [true|false]
+}
+```

 ### Certificates
 ### Certificates

-If this Windows only policy is set to true, Firefox reads certificates from the Windows certificate store.
+This policy can be used to install certificates or to read certificates from the system certificate store on Mac and Windows.
+
+The ImportEnterpriseRoots key will cause Firefox to import 3rd party certificates that have been added by a user administrator from the system certificate store.
+It does not import all certificates. These certificates will not display in the Firefox certificates manager.
+
+The Install Certificates key by default will search for certificates in the locations listed below. 
+Starting in Firefox 65 you can specify a fully qualified path including UNC. (See cert3.der and cert4.pem, in example).
+
+**Be advised if you wish to load a certificate from a UNC path you must use double backslashes.**
+Example: \\\\SERVER\\CERTS\\CERT5.PEM
+
+
+If Firefox does not find something at your fully qualified path, it will search the default directories.
+
+Certificates can be located in the following locations:
+- Windows
+  - %USERPROFILE%\AppData\Local\Mozilla\Certificates
+  - %USERPROFILE%\AppData\Roaming\Mozilla\Certificates
+- macOS
+  - /Library/Application Support/Mozilla/Certificates
+  - ~/Library/Application Support/Mozilla/Certificates
+- Linux
+  - /usr/lib/mozilla/certificates
+  - /usr/lib64/mozilla/certificates
+  - ~/.mozilla/certificates
+
+

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

-      "ImportEnterpriseRoots": [true|false]
+      "ImportEnterpriseRoots": true,
+      "Install": ["cert1.der", "cert2.pem", "%SYSTEMDRIVE%\\Company\\cert3.der", "/Library/Company/cert4.pem", "\\\\server\\certs\\cert.pem"]

     }
   }
 }
     }
   }
 }


@@ -100,11 +152,34 @@ This policy controls various settings related to cookies.
       "Default": [true|false], /* This sets the default value for "Accept cookies from websites" */
       "AcceptThirdParty": ["always", "never", "from-visited"], /* This sets the default value for "Accept third-party cookies" */
       "ExpireAtSessionEnd":  [true|false], /* This determines when cookies expire */
       "Default": [true|false], /* This sets the default value for "Accept cookies from websites" */
       "AcceptThirdParty": ["always", "never", "from-visited"], /* This sets the default value for "Accept third-party cookies" */
       "ExpireAtSessionEnd":  [true|false], /* This determines when cookies expire */

+      "RejectTracker": [true|false], /* Only reject trackers */

       "Locked": [true|false] /* If this is true, cookies preferences can't be changed */
     }
   }
 }
 ```
       "Locked": [true|false] /* If this is true, cookies preferences can't be changed */
     }
   }
 }
 ```

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


@@ -114,7 +189,7 @@ If this policy is set to true, the master password functionality is removed.
   }
 }
 ```
   }
 }
 ```

-### DisableAppUpdate (Machine only)
+### DisableAppUpdate

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


@@ -232,7 +307,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 and macOS only.

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


@@ -252,7 +327,7 @@ This policy prevents the user from bypassing security in certain cases.
   }
 }
 ```
   }
 }
 ```

-### DisableSystemAddonUpdate (Machine only)
+### DisableSystemAddonUpdate

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


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

-### DisableTelemetry (Machine only)
+### DisableTelemetry

 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.


@@ -304,9 +379,11 @@ 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 regular browser and private browsing.

 
 

-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.
+If Value is set to true, tracking protection is enabled by default in both the regular browser and private browsing.
+
+You can choose to set the Locked value if you want to prevent the user from changing it.

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


@@ -316,7 +393,7 @@ If Value is set to true, tracking protection is enabled by default in both the b
     }
 }
 ```
     }
 }
 ```

-### Extensions (Machine only)
+### Extensions

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


@@ -324,10 +401,28 @@ 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"]
     }

+  }
+}
+```
+### ExtensionUpdate
+This policy enables or disables extension updates by setting and locking the preference `extensions.update.enabled`.
+```
+{
+  "policies": {
+    "ExtensionUpdate": [true|false]
+}
+```
+### HardwareAcceleration
+This policy disables hardware acceleration by locking the preference layers.acceleration.disabled to true.
+```
+{
+  "policies": {
+    "HardwareAcceleration": false
+  }

 }
 ```
 ### NoDefaultBookmarks
 }
 ```
 ### NoDefaultBookmarks


@@ -348,8 +443,8 @@ This policy sets the signon.rememberSignons preference. It determines whether or
   }
 }
 ```
   }
 }
 ```

-### Homepage (Machine only)
-This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
+### Homepage
+This policy sets the default homepage value and the default start page.  It can also be used to lock the homepage or add additional homepages.

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


@@ -357,7 +452,8 @@ This policy sets the default homepage value. It can also be used to lock the hom
       "URL": "http://example.com/",
       "Locked": true,
       "Additional": ["http://example.org/",
       "URL": "http://example.com/",
       "Locked": true,
       "Additional": ["http://example.org/",

-                     "http://example.edu/"]
+                     "http://example.edu/"],
+      "StartPage": ["none", "homepage", "previous-session"]

     }
   }
 }
     }
   }
 }


@@ -403,7 +499,15 @@ This policy sets the behavior of Flash on the specified domains, as well as the
   }
 }
 ```
   }
 }
 ```

-### OverrideFirstRunPage (Machine only)
+### NetworkPrediction
+This policy enables or disables network prediction (DNS prefetching) by setting and locking the preferences `network.dns.disablePrefetch` and `network.dns.disablePrefetchFromHTTPS`.
+```
+{
+  "policies": {
+    "NetworkPrediction": [true|false]
+}
+```
+### OverrideFirstRunPage

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


@@ -412,7 +516,7 @@ This policy allows you to override the first run page. If you leave the URL blan
   }
 }
 ```
   }
 }
 ```

-### OverridePostUpdatePage (Machine only)
+### OverridePostUpdatePage

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


@@ -421,23 +525,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 */

       }
       }

-    ]
+    }

   }
 }
 ```
   }
 }
 ```


@@ -464,6 +582,15 @@ To specify ports, append them to the hostnames with a colon (:). If Locked is se
   }
 }
 ```
   }
 }
 ```

+### RequestedLocales
+This policy sets the list of requested locales for the application in order of preference. It will cause the corresponding language pack to become active.
+```
+{
+  "policies": {
+    "RequestedLocales": ["de", "en-US"]
+  }
+}
+```

 ### SanitizeOnShutdown
 If this policy is set to true,  all data is cleared when Firefox is closed. This includes Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data.
 ```
 ### SanitizeOnShutdown
 If this policy is set to true,  all data is cleared when Firefox is closed. This includes Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data.
 ```


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

-### WebsiteFilter (Machine only)
+### WebsiteFilter

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


@@ -495,7 +622,7 @@ This policy blocks websites from being visited. The parameters take an array of
 }
 ```
 ### Search Engines (This policy is only available on the ESR.)
 }
 ```
 ### Search Engines (This policy is only available on the ESR.)

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


@@ -512,8 +639,39 @@ 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)"]
+    }
+  }
+}
+```
+### SecurityDevices
+This policy allows you to add PKCS #11 Modules
+```
+{
+  "policies": {
+    "SecurityDevices": {
+      "NAME_OF_DEVICE": "PATH_TO_LIBRARY_FOR_DEVICE"

     }
   }
 }
 ```
     }
   }
 }
 ```

+### SSLVersionMin
+This policy allows you to set the minimum TLS version.
+```
+{
+  "policies": {
+    "SSSLVersionMin": ["tls1", "tls1.1", "tls1.2",. "tls1.3"]
+  }
+}
+
+```
+### SSLVersionMax
+This policy allows you to set the maximum TLS version.
+```
+{
+  "policies": {
+    "SSSLVersionMax": ["tls1", "tls1.1", "tls1.2",. "tls1.3"]
+  }
+}
+```