Update README.md

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 9062eedaa978290fb7c2ba22f0b9b7e8470874c4..6bd702076933a2569cc90cb0465d92f0a3aa09c4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,7 @@
-Policies can either be specified using the GPO templates or by putting a file called policies.json in the distribution directory.
+**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 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:
 ```
 {


@@ -7,8 +10,37 @@ The content of the JSON file should look like this:
   }
 }
 ```
   }
 }
 ```

-Policies are documented below.
+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.
+
+### 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.
+```
+{
+  "policies": {
+    "Authentication": {
+      "SPNEGO": ["mydomain.com", "https://myotherdomain.com"],
+      "Delegated": ["mydomain.com", "https://myotherdomain.com"],
+      "NTLM": ["mydomain.com", "https://myotherdomain.com"],
+      "AllowNonFQDN": {
+        "SPNEGO": true,
+        "NTLM": true
+      }
+    }
+  }
+}
+```

 ### BlockAboutAddons
 This policy removes access to about:addons.
 ```
 ### BlockAboutAddons
 This policy removes access to about:addons.
 ```


@@ -44,21 +76,108 @@ This policy removes access to about:support.
     "BlockAboutSupport": true
 }
 ```
     "BlockAboutSupport": true
 }
 ```

-### BlockSetDesktopBackground
+### 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"
+      }
+    ]
+  }
+}
+```
+### Certificates
+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 from the system certificate store.
+
+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, cer5.pem in example).
+
+**Be advised if you wish to load a certificate from a UNC path you must use double backslahes.**
+
+**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": {
+      "ImportEnterpriseRoots": true,
+      "Install": ["cert1.der", "cert2.pem", "%SYSTEMDRIVE%\Company\cert3.der", "/Library/Company/cert4.pem"]
+    }
+  }
+}
+```
+### Cookies
+This policy controls various settings related to cookies.
+```
+{
+  "policies": {
+    "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" */
+      "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 */
+    }
+  }
+}
+```
+### 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": {
 This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
 ```
 {
   "policies": {

-    "BlockAboutSupport": true
+    "DisableSetDesktopBackground": true

   }
 }
 ```
   }
 }
 ```

-### CreateMasterPassword
-This policy removes the master password functionality.
+### DisableMasterPasswordCreation
+If this policy is set to true, the master password functionality is removed.

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

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

   }
 }
 ```
   }
 }
 ```


@@ -90,7 +209,7 @@ This policy removes access to all developer tools.
 }
 ```
 ### DisableFeedbackCommands
 }
 ```
 ### DisableFeedbackCommands

-This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site)
+This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site).

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


@@ -99,7 +218,7 @@ This policy disables the menus for reporting sites (Submit Feedback, Report Dece
 }
 ```
 ### DisableFirefoxScreenshots
 }
 ```
 ### DisableFirefoxScreenshots

-This policy removes access to Firefox Screenshots
+This policy removes access to Firefox Screenshots.

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


@@ -108,7 +227,7 @@ This policy removes access to Firefox Screenshots
 }
 ```
 ### DisableFirefoxAccounts
 }
 ```
 ### DisableFirefoxAccounts

-This policy disables Sync
+This policy disables Sync.

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


@@ -117,16 +236,25 @@ This policy disables Sync
 }
 ```
 ### DisableFirefoxStudies
 }
 ```
 ### DisableFirefoxStudies

-This policy disables Firefox studies (Shield)
+This policy disables Firefox studies (Shield).

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

-    "DisableFirefoxAccounts": true
+    "DisableFirefoxStudies": true
+  }
+}
+```
+### DisableForgetButton
+This policy disables the "Forget" button.
+```
+{
+  "policies": {
+    "DisableForgetButton": true

   }
 }
 ```
 ### DisableFormHistory
   }
 }
 ```
 ### DisableFormHistory

-This policy turns off the browser.formfill.enable preferences
+This policy turns off the browser.formfill.enable preferences.

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


@@ -135,7 +263,7 @@ This policy turns off the browser.formfill.enable preferences
 }
 ```
 ### DisablePocket
 }
 ```
 ### DisablePocket

-This policy turns off Pocket
+This policy turns off Pocket.

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


@@ -144,7 +272,7 @@ This policy turns off Pocket
 }
 ```
 ### DisablePrivateBrowsing
 }
 ```
 ### DisablePrivateBrowsing

-This policy removes access to private browsing
+This policy removes access to private browsing.

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


@@ -152,8 +280,26 @@ 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.
+```
+{
+  "policies": {
+    "DisableProfileRefresh": true
+  }
+}
+```

 ### DisableSafeMode
 ### DisableSafeMode

-This policy disables safe mode on Windows only
+This policy disables safe mode on Windows and macOS only.

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


@@ -161,17 +307,40 @@ This policy disables safe mode on Windows only
   }
 }
 ```
   }
 }
 ```

-### DisableSysAddonUpdate
+### DisableSecurityBypass
+This policy prevents the user from bypassing security in certain cases.
+```
+{
+  "policies": {
+    "DisableSecurityBypass": {
+      "InvalidCertificate": [true|false], /* Prevents adding an exception when an invalid certificate is shown */
+      "SafeBrowsing": [true|false]        /* Prevents selecting "ignore the risk" and visiting a harmful site anyway */
+    }
+  }
+}
+```
+### 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
+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": {
+    "DisableTelemetry": true

   }
 }
 ```
 ### DisplayBookmarksToolbar
   }
 }
 ```
 ### DisplayBookmarksToolbar

-This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
+This policy turns on the bookmarks toolbar by default. A user can still turn it off, and it will stay off.

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


@@ -180,7 +349,7 @@ This policy turns on the bookmarks toolbar by default. A user can still turn it
 }
 ```
 ### DisplayMenuBar
 }
 ```
 ### DisplayMenuBar

-This policy turns on the menubar by default. A user can still turn it off and it will stay off.
+This policy turns on the menubar by default. A user can still turn it off, and it will stay off.

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


@@ -200,11 +369,13 @@ This policy stops Firefox from checking if it is the default browser at startup.
 ### EnableTrackingProtection
 This policy affects tracking protection.
 
 ### EnableTrackingProtection
 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, 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 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": {


@@ -212,36 +383,51 @@ 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]
     }

+}

 ```
 ```

-### NoDefaultBookmarks
-Don't create the default bookmarks. Note: this policy is only effective if used before the first run of the profile.
+### 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.

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

-    "NoDefaultBookmarks": true
+    "Extensions": {
+      "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

   }
 }
 ```
   }
 }
 ```

-### NoSmartBookmarks
-Remove the Smart Bookmarks (Most Visited, Recent Tags)
+### 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.

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

-    "NoSmartBookmarks": true
+    "NoDefaultBookmarks": true

   }
 }
 ```
   }
 }
 ```

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

   }
 }
 ```
 ### Homepage
   }
 }
 ```
 ### Homepage

-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 and the default start page.  It can also be used to lock the homepage or add additional homepages.

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


@@ -249,75 +435,199 @@ 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"]

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

-### Popups
-This policy sets domains for which popups are allowed
+### PopupBlocking
+This policy sets domains for which pop-up windows are allowed. It also sets the default pop-up policy.

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

-    "Popups": {
+    "PopupBlocking": {

       "Allow": ["http://example.org/",
       "Allow": ["http://example.org/",

-                "http://example.edu/"]
+                "http://example.edu/"],
+      "Default": [true|false], /* If this is set to false, pop-up window are enabled by default. */
+      "Locked": [true|false]

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

-### InstallAddons
-This policy sets domains that can install extensions
+### InstallAddonsPermission
+This policy sets domains that can install extensions, as well as the default behavior.

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

-    "InstallAddons": {
+    "InstallAddonsPermission": {

       "Allow": ["http://example.org/",
       "Allow": ["http://example.org/",

-                "http://example.edu/"]
+                "http://example.edu/"],
+      "Default": [true|false] /* If this is set to false, add-ons cannot be installed by the user */

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

-### Cookies
-This policy sets domains that can set or not set cookies.
+### FlashPlugin
+This policy sets the behavior of Flash on the specified domains, as well as the default behavior.

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

-    "Cookies": {
-      "Allow": ["http://example.org/"],
-      "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 */
+      "Locked": [true|false]

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

-### FlashPlugin
-This policy sets domains that can use or not use Flash
+### 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.

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

-    "FlashPlugin": {
-      "Allow": ["http://example.org/"],
-      "Block": ["http://example.edu/"]
+    "OverrideFirstRunPage": "http://example.org"
+  }
+}
+```
+### OverridePostUpdatePage
+This policy allows you to override the upgrade page. If you leave the URL blank, the upgrade page will not be displayed.
+```
+{
+  "policies": {
+    "OverridePostUpdatePage": "http://example.org"
+  }
+}
+```
+### 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 */
+      }

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

-### 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.
-
+### Proxy
+This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences.
+To specify ports, append them to the hostnames with a colon (:). If Locked is set to true, the values can't be changed by the user.
+```
+{
+  "policies": {
+    "Proxy": {
+      "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"],
+      "Locked": [true, false],
+      "HTTPProxy": "hostname",
+      "UseHTTPProxyForAllProtocols": [true, false],
+      "SSLProxy": "hostname",
+      "FTPProxy": "hostname",
+      "SOCKSProxy": "hostname",
+      "SOCKSVersion": [4, 5],
+      "Passthrough": "List of passthrough addresses/domains",
+      "AutoConfigURL": "URL_TO_AUTOCONFIG",
+      "AutoLogin":  [true, false],
+      "UseProxyForDNS": [true, false]
+    }
+  }
+}
+```
+### 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": {
 ```
 {
   "policies": {

-    "Bookmarks": [
-    {"Title": "Example",
-     "URL": "http://example.org",
-     "Favicon": "http://example.com/favicon.ico",
-     "Placement": ["toolbar", "menu"],
-     "Folder": "FolderName"
-     }
-    ]
+    "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.
+```
+{
+  "policies": {
+    "SanitizeOnShutdown": [true|false]
+  }
+}
+```
+### SearchBar
+This policy can be used to determine if the search bar is separate or combined with the URL bar.
+```
+{
+  "policies": {
+    "SearchBar": ["unified", "separate"]
+  }
+}
+```
+### 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.
+```
+{
+  "policies": {
+    "WebsiteFilter": {
+      "Block": ["<all_urls>"],
+      "Exceptions": ["http://example.org/*"]
+    }
+  }
+}
+```
+### 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": {
+    "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],
+      "Remove": ["Twitter", "Wikipedia (en)"]
+    }
+  }
+}
+```
+### SecurityDevices
+This policy allows you to add PKCS #11 Modules
+```
+{
+  "policies": {
+    "SecurityDevices": {
+      "NAME_OF_DEVICE": "PATH_TO_LIBRARY_FOR_DEVICE"
+    }

   }
 }
 ```
   }
 }
 ```