Merge pull request #664 from clear-code/fix-issue-663

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 4216c47180f70f35b35c72800f9cdd354c0cac97..f68860620f3ff9de5b24a0ef7bd7fbda053912e4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -19,8 +19,6 @@ Policies can be specified using the [Group Policy templates on Windows](https://
 | **[`Certificates -> ImportEnterpriseRoots`](#certificates--importenterpriseroots)** | Trust certificates that have been added to the operating system certificate store by a user or administrator.
 | **[`Certificates -> Install`](#certificates--install)** | Install certificates into the Firefox certificate store.
 | **[`Cookies`](#cookies)** | Configure cookie preferences.
 | **[`Certificates -> ImportEnterpriseRoots`](#certificates--importenterpriseroots)** | Trust certificates that have been added to the operating system certificate store by a user or administrator.
 | **[`Certificates -> Install`](#certificates--install)** | Install certificates into the Firefox certificate store.
 | **[`Cookies`](#cookies)** | Configure cookie preferences.

-| **[`DisableSetDesktopBackground`](#disablesetdesktopbackground)** | Remove the "Set As Desktop Background..." menuitem when right clicking on an image.
-| **[`DisableMasterPasswordCreation`](#disablemasterpasswordcreation)** | Remove the master password functionality.

 | **[`DisableAppUpdate`](#disableappupdate)** | Turn off application updates.
 | **[`DisableBuiltinPDFViewer`](#disablebuiltinpdfviewer)** | Disable the built in PDF viewer.
 | **[`DisabledCiphers`](#disabledciphers)** | Disable ciphers.
 | **[`DisableAppUpdate`](#disableappupdate)** | Turn off application updates.
 | **[`DisableBuiltinPDFViewer`](#disablebuiltinpdfviewer)** | Disable the built in PDF viewer.
 | **[`DisabledCiphers`](#disabledciphers)** | Disable ciphers.


@@ -32,6 +30,7 @@ Policies can be specified using the [Group Policy templates on Windows](https://
 | **[`DisableFirefoxStudies`](#disablefirefoxstudies)** | Disable Firefox studies (Shield).
 | **[`DisableForgetButton`](#disableforgetbutton)** | Disable the "Forget" button.
 | **[`DisableFormHistory`](#disableformhistory)** | Turn off saving information on web forms and the search bar.
 | **[`DisableFirefoxStudies`](#disablefirefoxstudies)** | Disable Firefox studies (Shield).
 | **[`DisableForgetButton`](#disableforgetbutton)** | Disable the "Forget" button.
 | **[`DisableFormHistory`](#disableformhistory)** | Turn off saving information on web forms and the search bar.

+| **[`DisableMasterPasswordCreation`](#disablemasterpasswordcreation)** | Remove the master password functionality.

 | **[`DisablePasswordReveal`](#disablepasswordreveal)** | Do not allow passwords to be revealed in saved logins.
 | **[`DisablePocket`](#disablepocket)** | Remove Pocket in the Firefox UI.
 | **[`DisablePrivateBrowsing`](#disableprivatebrowsing)** | Remove access to private browsing.
 | **[`DisablePasswordReveal`](#disablepasswordreveal)** | Do not allow passwords to be revealed in saved logins.
 | **[`DisablePocket`](#disablepocket)** | Remove Pocket in the Firefox UI.
 | **[`DisablePrivateBrowsing`](#disableprivatebrowsing)** | Remove access to private browsing.


@@ -39,6 +38,7 @@ Policies can be specified using the [Group Policy templates on Windows](https://
 | **[`DisableProfileRefresh`](#disableprofilerefresh)** | Disable the Refresh Firefox button on about:support and support.mozilla.org
 | **[`DisableSafeMode`](#disablesafemode)** | Disable safe mode within the browser.
 | **[`DisableSecurityBypass`](#disablesecuritybypass)** | Prevent the user from bypassing security in certain cases.
 | **[`DisableProfileRefresh`](#disableprofilerefresh)** | Disable the Refresh Firefox button on about:support and support.mozilla.org
 | **[`DisableSafeMode`](#disablesafemode)** | Disable safe mode within the browser.
 | **[`DisableSecurityBypass`](#disablesecuritybypass)** | Prevent the user from bypassing security in certain cases.

+| **[`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 update.
 | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry
 | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar.
 | **[`DisableSystemAddonUpdate`](#disablesystemaddonupdate)** | Prevent system add-ons from being installed or update.
 | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry
 | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar.


@@ -863,6 +863,10 @@ Value (string):
 ### DisableMasterPasswordCreation
 Remove the master password functionality.
 
 ### DisableMasterPasswordCreation
 Remove the master password functionality.
 

+If this value is true, it works the same as setting [`PrimaryPassword`](#primarypassword) to false and removes the primary password functionality.
+
+If both DisableMasterPasswordCreation and PrimaryPassword are used, DisableMasterPasswordCreation takes precedent.
+

 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `noMasterPassword`\
 **Preferences Affected:** N/A
 **Compatibility:** Firefox 60, Firefox ESR 60\
 **CCK2 Equivalent:** `noMasterPassword`\
 **Preferences Affected:** N/A


@@ -2474,7 +2478,7 @@ Within each handler type, you specify the given mimeType/extension/scheme as a k
 
 #### Windows (GPO)
 ```
 
 #### Windows (GPO)
 ```

-Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) =
+Software\Policies\Mozilla\Firefox\Handlers (REG_MULTI_SZ) =

 {
   "mimeTypes": {
     "application/msword": {
 {
   "mimeTypes": {
     "application/msword": {


@@ -2957,7 +2961,9 @@ Value (string):
 ### PrimaryPassword
 Require or prevent using a primary (formerly master) password.
 
 ### PrimaryPassword
 Require or prevent using a primary (formerly master) password.
 

-If this value is true, a primary password is required. If this value is false, it works the same as `DisableMasterPasswordCreation` and removes the primary password functionality.
+If this value is true, a primary password is required. If this value is false, it works the same as if [`DisableMasterPasswordCreation`](#disablemasterpasswordcreation) was true and removes the primary password functionality.
+
+If both DisableMasterPasswordCreation and PrimaryPassword are used, DisableMasterPasswordCreation takes precedent.

 
 **Compatibility:** Firefox 79, Firefox ESR 78.1\
 **CCK2 Equivalent:** `noMasterPassword`\
 
 **Compatibility:** Firefox 79, Firefox ESR 78.1\
 **CCK2 Equivalent:** `noMasterPassword`\


@@ -3900,7 +3906,7 @@ To specify ports, append them to the hostnames with a colon (:).
 
 #### Windows (GPO)
 ```
 
 #### Windows (GPO)
 ```

-Software\Policies\Mozilla\Firefox\Proxy\Mode = "none", "system", "manual", "autoDetect", "autoConfig"
+Software\Policies\Mozilla\Firefox\Proxy\Mode = "none" | "system" | "manual" | "autoDetect" | "autoConfig"

 Software\Policies\Mozilla\Firefox\Proxy\Locked = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\=Proxy\HTTPProxy = https://httpproxy.example.com
 Software\Policies\Mozilla\Firefox\Proxy\UseHTTPProxyForAllProtocols = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\Proxy\Locked = 0x1 | 0x0
 Software\Policies\Mozilla\Firefox\=Proxy\HTTPProxy = https://httpproxy.example.com
 Software\Policies\Mozilla\Firefox\Proxy\UseHTTPProxyForAllProtocols = 0x1 | 0x0


@@ -3971,7 +3977,7 @@ Value (string):
 {
   "policies": {
     "Proxy": {
 {
   "policies": {
     "Proxy": {

-      "Mode": "none", "system", "manual", "autoDetect", "autoConfig",
+      "Mode": "none" | "system" | "manual" | "autoDetect" | "autoConfig",

       "Locked": true | false,
       "HTTPProxy": "hostname",
       "UseHTTPProxyForAllProtocols": true | false,
       "Locked": true | false,
       "HTTPProxy": "hostname",
       "UseHTTPProxyForAllProtocols": true | false,


@@ -4635,11 +4641,11 @@ Value (string):
 ```
 ### UserMessaging
 
 ```
 ### UserMessaging
 

-Prevent installing search engines from webpages.
+Prevent Firefox from messaging the user in certain situations.

 
 `WhatsNew` Remove the "What's New" icon and menuitem. (Firefox 75 only)
 
 
 `WhatsNew` Remove the "What's New" icon and menuitem. (Firefox 75 only)
 

-`ExtensionRecommendations` Don't recommend extensions.
+`ExtensionRecommendations` Don't recommend extensions while the user is visiting web pages.

 
 `FeatureRecommendations` Don't recommend browser features.
 
 
 `FeatureRecommendations` Don't recommend browser features.