Add BackgroundAppUpdate (Fixes #756)

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 6ab2d64372863ff93cbc71c778b2205babe261b6..777e94f0721b2af9e9917462d3d0c851e155e5bd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,6 +10,7 @@ Policies can be specified using the [Group Policy templates on Windows](https://
 | **[`AppAutoUpdate`](#appautoupdate)** | Enable or disable automatic application update.
 | **[`AppUpdateURL`](#appupdateurl)** | Change the URL for application update.
 | **[`Authentication`](#authentication)** | Configure sites that support integrated authentication.
+| **[`BackgroundAppUpdate`](#backgroundappupdate)** | Enable or disable automatic application update in the background, when the application is not running.
 | **[`BlockAboutAddons`](#blockaboutaddons)** | Block access to the Add-ons Manager (about:addons).
 | **[`BlockAboutConfig`](#blockaboutconfig)** | Block access to about:config.
 | **[`BlockAboutProfiles`](#blockaboutprofiles)** | Block access to About Profiles (about:profiles).
@@ -64,6 +65,7 @@ Policies can be specified using the [Group Policy templates on Windows](https://
 | **[`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.
+| **[`ManualAppUpdateOnly`](#manualappupdateonly)** | Allow manual updates only and do not notify the user about updates..
 | **[`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.
@@ -325,6 +327,48 @@ Value (string):
   }
 }
 ```
+### BackgroundAppUpdate
+
+Enable or disable **automatic** application update **in the background**, when the application is not running.
+
+If set to true, application updates may be installed (without user approval) in the background, even when the application is not running. The operating system might still require approval.
+
+If set to false, the application will not try to install updates when the application is not running.
+
+If you have disabled updates via `DisableAppUpdate` or disabled automatic updates via `AppUpdateAuto`, this policy has no effect.
+
+**Compatibility:** Firefox 89\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** `app.update.background.enabled`
+
+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\BackgroundAppUpdate = 0x1 | 0x0
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/BackgroundAppUpdate
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+#### macOS
+```
+<dict>
+  <key>BackgroundAppUpdate</key>
+  <true/> | <false/>
+</dict>
+```
+#### policies.json
+```
+{
+  "policies": {
+    "BackgroundAppUpdate": true | false
+  }
+}
+```
 ### BlockAboutAddons
 
 Block access to the Add-ons Manager (about:addons).
@@ -3162,6 +3206,29 @@ Value (string):
   }
 }
 ```
+### ManualAppUpdateOnly
+
+Switch to manual updates only.
+
+If this policy is enabled:
+ 1. The user will never be prompted to install updates
+ 2. Firefox will not check for updates in the background, though it will check automatically when an update UI is displayed (such as the one in the About dialog). This check will be used to show "Update to version X" in the UI, but will not automatically download the update or prompt the user to update in any other way.
+ 3. The update UI will work as expected, unlike when using DisableAppUpdate.
+
+This policy is primarily intended for advanced end users, not for enterprises.
+
+**Compatibility:** Firefox 87\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** N/A
+
+#### policies.json
+```
+{
+  "policies": {
+    "ManualAppUpdateOnly": true | false
+  }
+}
+```
 ### PrimaryPassword
 Require or prevent using a primary (formerly master) password.