Add code examples

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 2c1a8ff78c58f8f50e0086e82bab36f2c1d52041..9f6504f41c1e1eb689bc0a49b55b0bdf997a695c 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.


@@ -1646,11 +1647,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)
 ```


@@ -2989,6 +2992,136 @@ Value (string):
   }
 }
 ```
   }
 }
 ```

+### ManagedBookmarks
+Configures a list of bookmarks managed by an administrator that cannot be changed by the user.
+
+**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="ManagedBookmarks" 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 +3337,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 +3374,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`\


@@ -3763,6 +3898,8 @@ 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.
 geo.
 intl.
 layout.


@@ -3770,6 +3907,7 @@ media.
 network.
 places.
 print.
 network.
 places.
 print.

+signon. (Firefox 83, Firefox ESR 78.5)

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


@@ -4933,7 +5071,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\