Update docs to be clearer. Fixes #729.

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 81cab81d1536a78ff3b2d3bc07d8aa416befba2e..16286737cc69402ae345ce49ef7bc8b48c1599a5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -62,6 +62,7 @@ Policies can be specified using the [Group Policy templates on Windows](https://
 | **[`InstallAddonsPermission`](#installaddonspermission)** | Configure the default extension install policy as well as origins for extension installs are allowed.
 | **[`LegacyProfiles`](#legacyprofiles)** | Disable the feature enforcing a separate profile for each installation.
 | **[`LocalFileLinks`](#localfilelinks)** | Enable linking to local files by origin.
 | **[`InstallAddonsPermission`](#installaddonspermission)** | Configure the default extension install policy as well as origins for extension installs are allowed.
 | **[`LegacyProfiles`](#legacyprofiles)** | Disable the feature enforcing a separate profile for each installation.
 | **[`LocalFileLinks`](#localfilelinks)** | Enable linking to local files by origin.

+| **[`ManagedBookmarks`](#managedbookmarks)** | Configures a list of bookmarks managed by an administrator that cannot be changed by the user.

 | **[`PrimaryPassword`](#primarypassword)** | Require or prevent using a primary (formerly master) password.
 | **[`NetworkPrediction`](#networkprediction)** | Enable or disable network prediction (DNS prefetching).
 | **[`NewTabPage`](#newtabpage)** | Enable or disable the New Tab page.
 | **[`PrimaryPassword`](#primarypassword)** | Require or prevent using a primary (formerly master) password.
 | **[`NetworkPrediction`](#networkprediction)** | Enable or disable network prediction (DNS prefetching).
 | **[`NewTabPage`](#newtabpage)** | Enable or disable the New Tab page.


@@ -100,7 +101,7 @@ Policies can be specified using the [Group Policy templates on Windows](https://
 
 Enable or disable **automatic** application update.
 
 
 Enable or disable **automatic** application update.
 

-If set to true, application updates are installed without user approval.
+If set to true, application updates are installed without user approval within Firefox. The operating system might still require approval.

 
 If set to false, application updates are downloaded but the user can choose when to install the update.
 
 
 If set to false, application updates are downloaded but the user can choose when to install the update.
 


@@ -140,7 +141,7 @@ Value (string):
 ```
 ### AppUpdateURL
 
 ```
 ### AppUpdateURL
 

-Change the URL for application update.
+Change the URL for application update if you are providing Firefox updates from a custom update server.

 
 **Compatibility:** Firefox 62, Firefox ESR 60.2\
 **CCK2 Equivalent:** N/A\
 
 **Compatibility:** Firefox 62, Firefox ESR 60.2\
 **CCK2 Equivalent:** N/A\


@@ -465,6 +466,8 @@ Value (string):
 ```
 ### Bookmarks
 
 ```
 ### Bookmarks
 

+Note: [`ManagedBookmarks`](#managedbookmarks) is the new recommended way to add bookmarks. This policy will continue to be supported.
+

 Add bookmarks in either the bookmarks toolbar or menu. Only `Title` and `URL` are required. If `Placement` is not specified, the bookmark will be placed on the toolbar. If `Folder` is specified, it is automatically created and bookmarks with the same folder name are grouped together.
 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 Add bookmarks in either the bookmarks toolbar or menu. Only `Title` and `URL` are required. If `Placement` is not specified, the bookmark will be placed on the toolbar. If `Folder` is specified, it is automatically created and bookmarks with the same folder name are grouped together.
 
 **Compatibility:** Firefox 60, Firefox ESR 60\


@@ -901,7 +904,7 @@ Value (string):
 }
 ```
 ### DisableAppUpdate
 }
 ```
 ### DisableAppUpdate

-Turn off application updates.
+Turn off application updates within Firefox.

 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `disableFirefoxUpdates`\
 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `disableFirefoxUpdates`\


@@ -1050,7 +1053,7 @@ Value (string):
 ```
 {
   "policies": {
 ```
 {
   "policies": {

-    "DisabledCiphers" {
+    "DisabledCiphers": {

       "TLS_DHE_RSA_WITH_AES_128_CBC_SHA": true | false,
       "TLS_DHE_RSA_WITH_AES_256_CBC_SHA": true | false,
       "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": true | false,
       "TLS_DHE_RSA_WITH_AES_128_CBC_SHA": true | false,
       "TLS_DHE_RSA_WITH_AES_256_CBC_SHA": true | false,
       "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA": true | false,


@@ -1059,8 +1062,8 @@ Value (string):
       "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256": true | false,
       "TLS_RSA_WITH_AES_128_CBC_SHA": true | false,
       "TLS_RSA_WITH_AES_256_CBC_SHA": true | false,
       "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256": true | false,
       "TLS_RSA_WITH_AES_128_CBC_SHA": true | false,
       "TLS_RSA_WITH_AES_256_CBC_SHA": true | false,

-      "TLS_RSA_WITH_3DES_EDE_CBC_SHA": true | false
-      "TLS_RSA_WITH_AES_128_GCM_SHA256": true | false
+      "TLS_RSA_WITH_3DES_EDE_CBC_SHA": true | false,
+      "TLS_RSA_WITH_AES_128_GCM_SHA256": true | false,

       "TLS_RSA_WITH_AES_256_GCM_SHA384": true | false
     }
   }
       "TLS_RSA_WITH_AES_256_GCM_SHA384": true | false
     }
   }


@@ -1069,6 +1072,8 @@ Value (string):
 ### DisableDefaultBrowserAgent
 Prevent the default browser agent from taking any actions. Only applicable to Windows; other platforms don’t have the agent.
 
 ### DisableDefaultBrowserAgent
 Prevent the default browser agent from taking any actions. Only applicable to Windows; other platforms don’t have the agent.
 

+The browser agent is a Windows-only scheduled task which runs in the background to collect and submit data about the browser that the user has set as their OS default. More information is available [here](https://firefox-source-docs.mozilla.org/toolkit/mozapps/defaultagent/default-browser-agent/index.html).
+

 **Compatibility:** Firefox 75, Firefox ESR 68.7 (Windows only)\
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** N/A
 **Compatibility:** Firefox 75, Firefox ESR 68.7 (Windows only)\
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** N/A


@@ -1646,11 +1651,13 @@ Value (string):
 ### DisableTelemetry
 Prevent the upload of telemetry data.
 
 ### DisableTelemetry
 Prevent the upload of telemetry data.
 

+As of Firefox 83 and Firefox ESR 78.5, local storage of telemetry data is disabled as well.
+

 Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `disableTelemetry`\
 Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours.
 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `disableTelemetry`\

-**Preferences Affected:** `datareporting.healthreport.uploadEnabled,datareporting.policy.dataSubmissionEnabled`
+**Preferences Affected:** `datareporting.healthreport.uploadEnabled,datareporting.policy.dataSubmissionEnabled,toolkit.telemetry.archive.enabled`

 
 #### Windows (GPO)
 ```
 
 #### Windows (GPO)
 ```


@@ -2781,7 +2788,7 @@ Configure the default homepage and how Firefox starts.
 
 `StartPage` is how Firefox starts. The choices are no homepage, the default homepage or the previous session.
 
 
 `StartPage` is how Firefox starts. The choices are no homepage, the default homepage or the previous session.
 

-With Firefox 78, an additional option as added for `Startpage`, `homepage-locked`. This allows for locking the homepage, but still allowing the user to choose whether or not they want to restore their session.
+With Firefox 78, an additional option as added for `Startpage`, `homepage-locked`. If this is value is set for the Startpage, the user will always get the homepage at startup and cannot choose to restore their session.

 
 **Compatibility:** Firefox 60, Firefox ESR 60 (StartPage was added in Firefox 60, Firefox ESR 60.4, homepage-locked added in Firefox 78)\
 **CCK2 Equivalent:** `homePage`,`lockHomePage`\
 
 **Compatibility:** Firefox 60, Firefox ESR 60 (StartPage was added in Firefox 60, Firefox ESR 60.4, homepage-locked added in Firefox 78)\
 **CCK2 Equivalent:** `homePage`,`lockHomePage`\


@@ -2989,6 +2996,165 @@ Value (string):
   }
 }
 ```
   }
 }
 ```

+### ManagedBookmarks
+Configures a list of bookmarks managed by an administrator that cannot be changed by the user.
+
+The bookmarks are only added as a button on the personal toolbar. They are not in the bookmarks folder.
+
+The syntax of this policy is exactly the same as the [Chrome ManagedBookmarks policy](https://cloud.google.com/docs/chrome-enterprise/policies/?policy=ManagedBookmarks). The schema is:
+```
+{
+ "items": {
+  "id": "BookmarkType",
+  "properties": {
+   "children": {
+    "items": {
+     "$ref": "BookmarkType"
+    },
+    "type": "array"
+   },
+   "name": {
+    "type": "string"
+   },
+   "toplevel_name": {
+    "type": "string"
+   },
+   "url": {
+    "type": "string"
+   }
+  },
+  "type": "object"
+ },
+ "type": "array"
+}
+```
+**Compatibility:** Firefox 83, Firefox ESR 78.5\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** N/A
+
+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\ManagedBookmarks (REG_MULTI_SZ) =
+[
+  {
+    "toplevel_name": "My managed bookmarks folder"
+  },
+  {
+    "url": "example.com",
+    "name": "Example"
+  },
+  {
+    "name": "Mozilla links",
+    "children": [
+      {
+        "url": "https://mozilla.org",
+        "name": "Mozilla.org"
+      },
+      {
+        "url": "https://support.mozilla.org/",
+        "name": "SUMO"
+      }
+    ]
+  }
+]
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/ManagedBookmarks
+```
+Value (string):
+```
+<enabled/>
+<data id="JSON" value='
+[
+  {
+    "toplevel_name": "My managed bookmarks folder"
+  },
+  {
+    "url": "example.com",
+    "name": "Example"
+  },
+  {
+    "name": "Mozilla links",
+    "children": [
+      {
+        "url": "https://mozilla.org",
+        "name": "Mozilla.org"
+      },
+      {
+        "url": "https://support.mozilla.org/",
+        "name": "SUMO"
+      }
+    ]
+  }
+]'/>
+```
+#### macOS
+```
+<dict>
+  <key>ManagedBookmarks</key>
+  <array>
+    <dict>
+      <key>toplevel_name</key>
+      <string>My managed bookmarks folder</string></dict>
+      <dict>
+        <key>url</key>
+        <string>example.com</string>
+        <key>name</key>
+        <string>Example</string>
+      </dict>
+      <dict>
+      <key>name</key>
+      <string>Mozilla links</string>
+      <key>children</key>
+      <array>
+        <dict>
+          <key>url</key>
+          <string>https://mozilla.org</string>
+          <key>name</key>
+          <string>Mozilla</string>
+        </dict>
+        <dict>
+          <key>url</key>
+          <string>https://support.mozilla.org/</string>
+          <key>name</key>
+          <string>SUMO</string>
+        </dict>
+      </array>
+    </dict>
+  </array>
+</dict>
+```
+#### policies.json
+```
+{
+  "policies": {
+    "ManagedBookmarks": [
+      {
+        "toplevel_name": "My managed bookmarks folder"
+      },
+      {
+        "url": "example.com",
+        "name": "Example"
+      },
+      {
+        "name": "Mozilla links",
+        "children": [
+          {
+            "url": "https://mozilla.org",
+            "name": "Mozilla.org"
+          },
+          {
+            "url": "https://support.mozilla.org/",
+            "name": "SUMO"
+          }
+        ]
+      }
+    ]
+  }
+}
+```

 ### PrimaryPassword
 Require or prevent using a primary (formerly master) password.
 
 ### PrimaryPassword
 Require or prevent using a primary (formerly master) password.
 


@@ -3204,7 +3370,9 @@ Value (string):
 }
 ```
 ### OverrideFirstRunPage
 }
 ```
 ### OverrideFirstRunPage

-Override the first run page. If the value is blank, no first run page is displayed.
+Override the first run page. If the value is an empty string (""), the first run page is not displayed.
+
+Starting with Firefox 83, Firefox ESR 78.5, you can also specify multiple URLS separated by a vertical bar (|).

 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `welcomePage`,`noWelcomePage`\
 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `welcomePage`,`noWelcomePage`\


@@ -3239,7 +3407,7 @@ Value (string):
 }
 ```
 ### OverridePostUpdatePage
 }
 ```
 ### OverridePostUpdatePage

-Override the upgrade page. If the value is blank, no upgrade page is displayed.
+Override the upgrade page. If the value is an empty string (""), no extra pages are displayed when Firefox is upgraded.

 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `upgradePage`,`noUpgradePage`\
 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `upgradePage`,`noUpgradePage`\


@@ -3639,7 +3807,7 @@ Value (string):
 ```
 ### PictureInPicture
 
 ```
 ### PictureInPicture
 

-Enable or disable Picture-in-Picture.
+Enable or disable Picture-in-Picture as well as prevent the user from enabling or disabling it (Locked).

 
 **Compatibility:** Firefox 78, Firefox ESR 78\
 **CCK2 Equivalent:** N/A\
 
 **Compatibility:** Firefox 78, Firefox ESR 78\
 **CCK2 Equivalent:** N/A\


@@ -3647,12 +3815,15 @@ Enable or disable Picture-in-Picture.
 
 #### Windows (GPO)
 ```
 
 #### Windows (GPO)
 ```

-Software\Policies\Mozilla\Firefox\PictureInPicture = 0x1 | 0x0
+Software\Policies\Mozilla\Firefox\PictureInPicture\Enabled = 0x1 | 0x0
+Software\Policies\Mozilla\Firefox\PictureInPicture\Locked = 0x1 | 0x0
+

 ```
 #### Windows (Intune)
 OMA-URI:
 ```
 ```
 #### Windows (Intune)
 OMA-URI:
 ```

-./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/PictureInPicture
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~PictureInPicture/PictureInPicture_Enabled
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~PictureInPicture/PictureInPicture_Locked

 ```
 Value (string):
 ```
 ```
 Value (string):
 ```


@@ -3662,14 +3833,22 @@ Value (string):
 ```
 <dict>
   <key>PictureInPicture</key>
 ```
 <dict>
   <key>PictureInPicture</key>

-  <true/> | <false/>
+  <dict>
+    <key>Enabled</key>
+    <true/> | <false/>
+    <key>Locked</key>
+    <true/> | <false/>
+  </dict>

 </dict>
 ```
 #### policies.json
 ```
 {
   "policies": {
 </dict>
 ```
 #### policies.json
 ```
 {
   "policies": {

-    "PictureInPicture": true | false
+    "PictureInPicture": {
+      "Enabled": true | false,
+      "Locked": true, false
+    }

   }
 }
 ```
   }
 }
 ```


@@ -3752,6 +3931,8 @@ Value (string):
 ### Preferences
 Set and lock preferences.
 
 ### Preferences
 Set and lock preferences.
 

+**NOTE** On Windows, in order to use this policy, you must clear all settings in the old **Preferences (Deprecated)** section.
+

 Previously you could only set and lock a subset of preferences. Starting with Firefox 81 and Firefox ESR 78.3 you can set many more preferences. You can also set default preferences, user preferences and you can clear preferences.
 
 Preferences that start with the following prefixes are supported:
 Previously you could only set and lock a subset of preferences. Starting with Firefox 81 and Firefox ESR 78.3 you can set many more preferences. You can also set default preferences, user preferences and you can clear preferences.
 
 Preferences that start with the following prefixes are supported:


@@ -3761,13 +3942,18 @@ browser.
 datareporting.policy.
 dom.
 extensions.
 datareporting.policy.
 dom.
 extensions.

+general.autoScroll (Firefox 83, Firefox ESR 78.5)
+general.smoothScroll (Firefox 83, Firefox ESR 78.5)

 geo.
 intl.
 layout.
 media.
 network.
 geo.
 intl.
 layout.
 media.
 network.

+pdfjs. (Firefox 84, Firefox ESR 78.6)

 places.
 print.
 places.
 print.

+signon. (Firefox 83, Firefox ESR 78.5)
+spellchecker. (Firefox 84, Firefox ESR 78.6)

 ui.
 widget.
 ```
 ui.
 widget.
 ```


@@ -3841,7 +4027,7 @@ OMA-URI:
 Value (string):
 ```
 <enabled/>
 Value (string):
 ```
 <enabled/>

-<data id="Preferences" value='
+<data id="JSON" value='

 {
   "accessibility.force_disabled": {
     "Value": 1,
 {
   "accessibility.force_disabled": {
     "Value": 1,


@@ -4306,6 +4492,70 @@ Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Locked = 0x1 | 0x0
 #### Windows (Intune)
 OMA-URI:
 ```
 #### Windows (Intune)
 OMA-URI:
 ```

+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/A_SanitizeOnShutdown_Cache
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/B_SanitizeOnShutdown_Cookies
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/C_SanitizeOnShutdown_Downloads
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/D_SanitizeOnShutdown_FormData
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/E_SanitizeOnShutdown_History
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/F_SanitizeOnShutdown_Sessions
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/G_SanitizeOnShutdown_SiteSettings
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/H_SanitizeOnShutdown_OfflineApps
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```

 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/I_SanitizeOnShutdown_Locked
 ```
 Value (string):
 ./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~SanitizeOnShutdown/I_SanitizeOnShutdown_Locked
 ```
 Value (string):


@@ -4931,7 +5181,10 @@ Value (string):
 }
 ```
 ### WebsiteFilter
 }
 ```
 ### WebsiteFilter

-Block 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.
+Block 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.
+The arrays are limited to 1000 entries each.
+
+As of Firefox 83 and Firefox ESR 78.5, file URLs are supported.

 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** N/A\
 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** N/A\