Merge pull request #999 from mozilla/ProxyCategory

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index c77fca8473f26aadc608b784808f321ea38cc20b..0665d8d741378a264f9dfd9abd0feb9f602d8890 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,6 +9,7 @@ Policies can be specified using the [Group Policy templates on Windows](https://
 | **[`3rdparty`](#3rdparty)** | Set policies that WebExtensions can access via chrome.storage.managed.
 | **[`AllowedDomainsForApps`](#alloweddomainsforapps)** | Define domains allowed to access Google Workspace.
 | **[`AppAutoUpdate`](#appautoupdate)** | Enable or disable automatic application update.
 | **[`3rdparty`](#3rdparty)** | Set policies that WebExtensions can access via chrome.storage.managed.
 | **[`AllowedDomainsForApps`](#alloweddomainsforapps)** | Define domains allowed to access Google Workspace.
 | **[`AppAutoUpdate`](#appautoupdate)** | Enable or disable automatic application update.

+| **[`AppUpdatePin`](#appupdatepin)** | Prevent Firefox from being updated beyond the specified version.

 | **[`AppUpdateURL`](#appupdateurl)** | Change the URL for application update.
 | **[`Authentication`](#authentication)** | Configure sites that support integrated authentication.
 | **[`AutoLaunchProtocolsFromOrigins`](#autolaunchprotocolsfromorigins)** | Define a list of external protocols that can be used from listed origins without prompting the user.
 | **[`AppUpdateURL`](#appupdateurl)** | Change the URL for application update.
 | **[`Authentication`](#authentication)** | Configure sites that support integrated authentication.
 | **[`AutoLaunchProtocolsFromOrigins`](#autolaunchprotocolsfromorigins)** | Define a list of external protocols that can be used from listed origins without prompting the user.


@@ -46,7 +47,9 @@ Policies can be specified using the [Group Policy templates on Windows](https://
 | **[`DisableSetDesktopBackground`](#disablesetdesktopbackground)** | Remove the "Set As Desktop Background..." menuitem when right clicking on an image.
 | **[`DisableSystemAddonUpdate`](#disablesystemaddonupdate)** | Prevent system add-ons from being installed or updated.
 | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry
 | **[`DisableSetDesktopBackground`](#disablesetdesktopbackground)** | Remove the "Set As Desktop Background..." menuitem when right clicking on an image.
 | **[`DisableSystemAddonUpdate`](#disablesystemaddonupdate)** | Prevent system add-ons from being installed or updated.
 | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry

+| **[`DisableThirdPartyModuleBlocking`](#disablethirdpartymoduleblocking)** | Do not allow blocking third-party modules.

 | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar.
 | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar.

+| **[`DisplayBookmarksToolbar (Deprecated)`](#displaybookmarkstoolbar-deprecated)** | Set the initial state of the bookmarks toolbar.

 | **[`DisplayMenuBar`](#displaymenubar)** | Set the state of the menubar.
 | **[`DisplayMenuBar (Deprecated)`](#displaymenubar-deprecated)** | Set the initial state of the menubar.
 | **[`DNSOverHTTPS`](#dnsoverhttps)** | Configure DNS over HTTPS.
 | **[`DisplayMenuBar`](#displaymenubar)** | Set the state of the menubar.
 | **[`DisplayMenuBar (Deprecated)`](#displaymenubar-deprecated)** | Set the initial state of the menubar.
 | **[`DNSOverHTTPS`](#dnsoverhttps)** | Configure DNS over HTTPS.


@@ -250,6 +253,49 @@ Value (string):
   }
 }
 ```
   }
 }
 ```

+### AppUpdatePin
+
+Prevent Firefox from being updated beyond the specified version.
+
+You can specify the any version as ```xx.``` and Firefox will be updated with all minor versions, but will not be updated beyond the major version.
+
+You can also specify the version as ```xx.xx``` and Firefox will be updated with all patch versions, but will not be updated beyond the minor version.
+
+You should specify a version that exists or is guaranteed to exist. If you specify a version that doesn't end up existing, Firefox will update beyond that version.
+
+**Compatibility:** Firefox 102,\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** N/A
+
+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\AppUpdatePin = "106."
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/AppUpdatePin
+```
+Value (string):
+```
+<enabled/>
+<data id="AppUpdatePin" value="106."/>
+```
+#### macOS
+```
+<dict>
+  <key>AppUpdatePin</key>
+  <string>106.</string>
+</dict>
+```
+#### policies.json
+```
+{
+  "policies": {
+    "AppUpdatePin": "106."
+  }
+}
+```

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


@@ -1165,6 +1211,7 @@ Value (string):
 {
   "policies": {
     "DefaultDownloadDirectory": "${home}/Downloads"
 {
   "policies": {
     "DefaultDownloadDirectory": "${home}/Downloads"

+  }

 }
 ```
 #### policies.json (Windows)
 }
 ```
 #### policies.json (Windows)


@@ -1172,6 +1219,7 @@ Value (string):
 {
   "policies": {
     "DefaultDownloadDirectory": "${home}\\Downloads"
 {
   "policies": {
     "DefaultDownloadDirectory": "${home}\\Downloads"

+  }

 }
 ```
 ### DisableAppUpdate
 }
 ```
 ### DisableAppUpdate


@@ -2005,7 +2053,71 @@ Value (string):
   }
 }
 ```
   }
 }
 ```

+### DisableThirdPartyModuleBlocking
+Do not allow blocking third-party modules from the `about:third-party` page.
+
+This policy only works on Windows through GPO (not policies.json).
+
+**Compatibility:** Firefox 110 (Windows only, GPO only)\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** N/A
+
+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\DisableThirdPartyModuleBlocking = = 0x1 | 0x0
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/DisableThirdPartyModuleBlocking
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```

 ### DisplayBookmarksToolbar
 ### DisplayBookmarksToolbar

+Set the initial state of the bookmarks toolbar. A user can still change how it is displayed.
+
+`always` means the bookmarks toolbar is always shown.
+
+`never` means the bookmarks toolbar is not shown.
+
+`newtab` means the bookmarks toolbar is only shown on the new tab page.
+
+**Compatibility:** Firefox 109, Firefox ESR 102.7\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** N/A
+
+#### Windows (GPO)
+```
+Software\Policies\Mozilla\Firefox\DisplayBookmarksToolbar = "always", "never", "newtab"
+```
+#### Windows (Intune)
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox/DisplayBookmarksToolbar_Enum
+```
+Value (string):
+```
+<enabled/>
+<data id="DisplayBookmarksToolbar" value="always | never | newtab"/>
+```
+#### macOS
+```
+<dict>
+  <key>DisplayBookmarksToolbar</key>
+  <string>always | never | newtab</string>
+</dict>
+```
+#### policies.json
+```
+{
+  "policies": {
+    "DisplayBookmarksToolbar": "always" | "never" | "newtab"
+  }
+}
+```
+### DisplayBookmarksToolbar (Deprecated)

 Set the initial state of the bookmarks toolbar. A user can still hide it and it will stay hidden.
 
 **Compatibility:** Firefox 60, Firefox ESR 60\
 Set the initial state of the bookmarks toolbar. A user can still hide it and it will stay hidden.
 
 **Compatibility:** Firefox 60, Firefox ESR 60\


@@ -2335,6 +2447,7 @@ OMA-URI:
 ```
 Value (string):
 ```
 ```
 Value (string):
 ```

+<enabled/>

 <data id="TrackingProtection_Exceptions" value="1&#xF000;https://example.com"/>
 ```
 OMA-URI:
 <data id="TrackingProtection_Exceptions" value="1&#xF000;https://example.com"/>
 ```
 OMA-URI:


@@ -2608,7 +2721,7 @@ The configuration for each extension is another dictionary that can contain the
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`force_installed`| The extension is automatically installed and can't be removed by the user. This option is not valid for the default configuration and requires an install_url.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`normal_installed`| The extension is automatically installed but can be disabled by the user. This option is not valid for the default configuration and requires an install_url.
 | `install_url`| Maps to a URL indicating where Firefox can download a force_installed or normal_installed extension.  If installing from the local file system, use a [```file:///``` URL](https://en.wikipedia.org/wiki/File_URI_scheme). If installing from the addons.mozilla.org, use the following URL (substituting SHORT_NAME from the URL on AMO), https://addons.mozilla.org/firefox/downloads/latest/SHORT_NAME/latest.xpi. Languages packs are available from https://releases.mozilla.org/pub/firefox/releases/VERSION/PLATFORM/xpi/LANGUAGE.xpi. If you need to update the extension, you can change the name of the extension and it will be automatically updated. Extensions installed from file URLs will additional be updated when their internal version changes.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`force_installed`| The extension is automatically installed and can't be removed by the user. This option is not valid for the default configuration and requires an install_url.
 | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`normal_installed`| The extension is automatically installed but can be disabled by the user. This option is not valid for the default configuration and requires an install_url.
 | `install_url`| Maps to a URL indicating where Firefox can download a force_installed or normal_installed extension.  If installing from the local file system, use a [```file:///``` URL](https://en.wikipedia.org/wiki/File_URI_scheme). If installing from the addons.mozilla.org, use the following URL (substituting SHORT_NAME from the URL on AMO), https://addons.mozilla.org/firefox/downloads/latest/SHORT_NAME/latest.xpi. Languages packs are available from https://releases.mozilla.org/pub/firefox/releases/VERSION/PLATFORM/xpi/LANGUAGE.xpi. If you need to update the extension, you can change the name of the extension and it will be automatically updated. Extensions installed from file URLs will additional be updated when their internal version changes.

-| `install_sources` | A list of sources from which installing extensions is allowed. **This is unnecessary if you are only allowing the installation of certain extensions by ID.** Each item in this list is an extension-style match pattern. Users will be able to easily install items from any URL that matches an item in this list. Both the location of the *.xpi file and the page where the download is started from (i.e.  the referrer) must be allowed by these patterns. This setting can be used only for the default configuration.
+| `install_sources` | A list of sources from which installing extensions is allowed using URL match patterns. **This is unnecessary if you are only allowing the installation of certain extensions by ID.** Each item in this list is an extension-style match pattern. Users will be able to easily install items from any URL that matches an item in this list. Both the location of the *.xpi file and the page where the download is started from (i.e.  the referrer) must be allowed by these patterns. This setting can be used only for the default configuration.

 | `allowed_types` | This setting whitelists the allowed types of extension/apps that can be installed in Firefox. The value is a list of strings, each of which should be one of the following: "extension", "theme", "dictionary", "locale" This setting can be used only for the default configuration.
 | `blocked_install_message` | This maps to a string specifying the error message to display to users if they're blocked from installing an extension. This setting allows you to append text to the generic error message displayed when the extension is blocked. This could be be used to direct users to your help desk, explain why a particular extension is blocked, or something else. This setting can be used only for the default configuration.
 | `restricted_domains` | An array of domains on which content scripts can't be run. This setting can be used only for the default configuration.
 | `allowed_types` | This setting whitelists the allowed types of extension/apps that can be installed in Firefox. The value is a list of strings, each of which should be one of the following: "extension", "theme", "dictionary", "locale" This setting can be used only for the default configuration.
 | `blocked_install_message` | This maps to a string specifying the error message to display to users if they're blocked from installing an extension. This setting allows you to append text to the generic error message displayed when the extension is blocked. This could be be used to direct users to your help desk, explain why a particular extension is blocked, or something else. This setting can be used only for the default configuration.
 | `restricted_domains` | An array of domains on which content scripts can't be run. This setting can be used only for the default configuration.


@@ -2624,7 +2737,7 @@ Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) =
 {
   "*": {
     "blocked_install_message": "Custom error message.",
 {
   "*": {
     "blocked_install_message": "Custom error message.",

-    "install_sources": ["about:addons","https://addons.mozilla.org/"],
+    "install_sources": ["https://yourwebsite.com/*"],

     "installation_mode": "blocked",
     "allowed_types": ["extension"]
   },
     "installation_mode": "blocked",
     "allowed_types": ["extension"]
   },


@@ -2649,7 +2762,7 @@ Value (string):
 {
   "*": {
     "blocked_install_message": "Custom error message.",
 {
   "*": {
     "blocked_install_message": "Custom error message.",

-    "install_sources": ["about:addons","https://addons.mozilla.org/"],
+    "install_sources": ["https://yourwebsite.com/*"],

     "installation_mode": "blocked",
     "allowed_types": ["extension"]
   },
     "installation_mode": "blocked",
     "allowed_types": ["extension"]
   },


@@ -2673,8 +2786,7 @@ Value (string):
       <string>Custom error message.</string>
       <key>install_sources</key>
       <array>
       <string>Custom error message.</string>
       <key>install_sources</key>
       <array>

-        <string>about:addons</string>
-        <string>https://addons.mozilla.org/</string>
+        <string>"https://yourwebsite.com/*"</string>

       </array>
       <key>installation_mode</key>
       <string>blocked</string>
       </array>
       <key>installation_mode</key>
       <string>blocked</string>


@@ -2705,7 +2817,7 @@ Value (string):
     "ExtensionSettings": {
       "*": {
         "blocked_install_message": "Custom error message.",
     "ExtensionSettings": {
       "*": {
         "blocked_install_message": "Custom error message.",

-        "install_sources": ["about:addons","https://addons.mozilla.org/"],
+        "install_sources": ["https://yourwebsite.com/*"],

         "installation_mode": "blocked",
         "allowed_types": ["extension"]
       },
         "installation_mode": "blocked",
         "allowed_types": ["extension"]
       },


@@ -4845,6 +4957,8 @@ Value (string):
 Configure proxy settings. These settings correspond to the connection settings in Firefox preferences.
 To specify ports, append them to the hostnames with a colon (:).
 
 Configure proxy settings. These settings correspond to the connection settings in Firefox preferences.
 To specify ports, append them to the hostnames with a colon (:).
 

+Unless you lock this policy, changes the user already has in place will take effect.
+

 `Mode` is the proxy method being used.
 
 `Locked` is whether or not proxy settings can be changed.
 `Mode` is the proxy method being used.
 
 `Locked` is whether or not proxy settings can be changed.


@@ -4889,8 +5003,106 @@ Software\Policies\Mozilla\Firefox\Proxy\AutoLogin = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0
 ```
 #### Windows (Intune)
 Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0
 ```
 #### Windows (Intune)

+**Note**
+These setttings were moved to a category to make them easier to configure via Intune.
+
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_Locked
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_ConnectionType
+```
+Value (string):
+```
+<enabled/>
+<data id="Proxy_ConnectionType" value="none | system | manual | autoDetect | autoConfig"/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_HTTPProxy
+```
+Value (string):
+```
+<enabled/>
+<data id="Proxy_HTTPProxy" value="httpproxy.example.com"/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_UseHTTPProxyForAllProtocols
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_SSLProxy
+```
+Value (string):
+```
+<enabled/>
+<data id="Proxy_SSLProxy" value="sslproxy.example.com"/>
+```

 OMA-URI:
 ```
 OMA-URI:
 ```

+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_SOCKSProxy
+```
+Value (string):
+```
+<enabled/>
+<data id="Proxy_SOCKSProxy" value="socksproxy.example.com"/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_SOCKSVersion
+```
+Value (string):
+```
+<enabled/>
+<data id="Proxy_SOCKSVersion" value="4 | 5"/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_AutoConfigURL
+```
+Value (string):
+```
+<enabled/>
+<data id="Proxy_AutoConfigURL" value="URL_TO_AUTOCONFIG"/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_Passthrough
+```
+Value (string):
+```
+<enabled/>
+<data id="Proxy_Passthrough" value="<local>"/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_AutoLogin
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI:
+```
+./Device/Vendor/MSFT/Policy/Config/Firefox~Policy~firefox~ProxySettings/Proxy_UseProxyForDNS
+```
+Value (string):
+```
+<enabled/> or <disabled/>
+```
+OMA-URI (Old way):
+```

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


@@ -4898,11 +5110,11 @@ Value (string):
 <enabled/>
 <data id="ProxyLocked" value="true | false"/>
 <data id="ConnectionType" value="none | system | manual | autoDetect | autoConfig"/>
 <enabled/>
 <data id="ProxyLocked" value="true | false"/>
 <data id="ConnectionType" value="none | system | manual | autoDetect | autoConfig"/>

-<data id="HTTPProxy" value="https://httpproxy.example.com"/>
+<data id="HTTPProxy" value="httpproxy.example.com"/>

 <data id="UseHTTPProxyForAllProtocols" value="true | false"/>
 <data id="UseHTTPProxyForAllProtocols" value="true | false"/>

-<data id="SSLProxy" value="https://sslproxy.example.com"/>
-<data id="FTPProxy" value="https://ftpproxy.example.com"/>
-<data id="SOCKSProxy" value="https://socksproxy.example.com"/>
+<data id="SSLProxy" value="sslproxy.example.com"/>
+<data id="FTPProxy" value="ftpproxy.example.com"/>
+<data id="SOCKSProxy" value="socksproxy.example.com"/>

 <data id="SOCKSVersion" value="4 | 5"/>
 <data id="AutoConfigURL" value="URL_TO_AUTOCONFIG"/>
 <data id="Passthrough" value="<local>"/>
 <data id="SOCKSVersion" value="4 | 5"/>
 <data id="AutoConfigURL" value="URL_TO_AUTOCONFIG"/>
 <data id="Passthrough" value="<local>"/>


@@ -5685,7 +5897,7 @@ Value (string):
 <enabled/>
 <data id="SupportMenuTitle" value="Support Menu"/>
 <data id="SupportMenuURL" value="http://example.com/support"/>
 <enabled/>
 <data id="SupportMenuTitle" value="Support Menu"/>
 <data id="SupportMenuURL" value="http://example.com/support"/>

-<data id="SupportMenuAccessKey" value="S">
+<data id="SupportMenuAccessKey" value="S"/>

 ```
 #### macOS
 ```
 ```
 #### macOS
 ```


@@ -5718,7 +5930,7 @@ Force downloads to start off in a local, temporary location rather than the defa
 
 **Compatibility:** Firefox 102\
 **CCK2 Equivalent:** N/A\
 
 **Compatibility:** Firefox 102\
 **CCK2 Equivalent:** N/A\

-**Preferences Affected:** `browser.downloads.start_downloads_in_tmp_dir`
+**Preferences Affected:** `browser.download.start_downloads_in_tmp_dir`

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