Merge pull request #453 from mozilla/LegacyProfiles

[policy-templates.git] / README.md

diff --git a/README.md b/README.md
index 2b66070fb0708aa72b1ad78ce5d66b83a78ac84e..60cc86ff37ab058312a8ab93190036a6725f0c8e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -53,6 +53,7 @@ Policies can be specified using the Group Policy templates on Windows (https://g
 | **[`HardwareAcceleration`](#hardwareacceleration)** | Control hardware acceleration.
 | **[`Homepage`](#homepage)** | Configure the default homepage and how Firefox starts.
 | **[`InstallAddonsPermission`](#installaddonspermission)** | Configure the default extension install policy as well as origins for extension installs are allowed.
 | **[`HardwareAcceleration`](#hardwareacceleration)** | Control hardware acceleration.
 | **[`Homepage`](#homepage)** | Configure the default homepage and how Firefox starts.
 | **[`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.
 | **[`NetworkPrediction`](#networkprediction)** | Enable or disable network prediction (DNS prefetching).
 | **[`NewTabPage`](#newtabpage)** | Enable or disable the New Tab page.
 | **[`LocalFileLinks`](#localfilelinks)** | Enable linking to local files by origin.
 | **[`NetworkPrediction`](#networkprediction)** | Enable or disable network prediction (DNS prefetching).
 | **[`NewTabPage`](#newtabpage)** | Enable or disable the New Tab page.


@@ -100,7 +101,7 @@ Software\Policies\Mozilla\Firefox\AppUpdateURL = "https://yoursite.com"
   <string>https://yoursite.com</string>
 </dict>
 ```
   <string>https://yoursite.com</string>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -159,7 +160,7 @@ Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\NTLM = 0x1 | 0x0
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -319,7 +320,7 @@ Software\Policies\Mozilla\Firefox\Bookmarks\1\Folder = "FolderName"
   </array>
 </dict>
 ```
   </array>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -1367,7 +1368,7 @@ The configuration for each extension is another dictionary that can contain the
 
 #### Windows
 ```
 
 #### Windows
 ```

-Software\Policies\Mozilla\Firefox\ExtensionSettings = '{"*": {"installation_mode": "blocked"}}'
+Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) = '{"*": {"installation_mode": "blocked"}}'

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


@@ -1671,6 +1672,23 @@ Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Default = 0x1 | 0x0
   }
 }
 ```
   }
 }
 ```

+### LegacyProfiles
+Disable the feature enforcing a separate profile for each installation.
+
+If this policy set to true, Firefox will not try to create different profiles for installations of Firefox in different directories. This is the equivalent of the MOZ_LEGACY_PROFILES environment variable.
+
+If this policy set to false, Firefox will create a new profile for each unique installation of Firefox.
+
+This policy only work on Windows via GPO (not policies.json).
+
+**Compatibility:** Firefox 70, Firefox ESR 68.2 (Windows only, GPO only)\
+**CCK2 Equivalent:** N/A\
+**Preferences Affected:** N/A
+
+#### Windows
+```
+Software\Policies\Mozilla\Firefox\LegacyProfiles = = 0x1 | 0x0
+```

 ### LocalFileLinks
 Enable linking to local files by origin.
 
 ### LocalFileLinks
 Enable linking to local files by origin.
 


@@ -2048,32 +2066,56 @@ Set and lock certain preferences.
 **CCK2 Equivalent:** `preferences`\
 **Preferences Affected:** See below
 
 **CCK2 Equivalent:** `preferences`\
 **Preferences Affected:** See below
 

-| Preference | Type | Compatibility
-| --- | --- | ---
-| app.update.auto | boolean | Firefox 68, Firefox 68 ESR
-| browser.cache.disk.enable | boolean | Firefox 68, Firefox 68 ESR
-| browser.cache.disk.parent_directory | string | Firefox 68, Firefox 68 ESR
-| browser.fixup.dns_first_for_single_words | boolean | Firefox 68, Firefox 68 ESR
-| browser.search.update | boolean | Firefox 68, Firefox 68 ESR
-| browser.tabs.warnOnClose | boolean | Firefox 68, Firefox 68 ESR
-| browser.urlbar.suggest.bookmark | boolean | Firefox 68, Firefox 68 ESR
-| browser.urlbar.suggest.history | boolean | Firefox 68, Firefox 68 ESR
-| browser.urlbar.suggest.openpage | boolean | Firefox 68, Firefox 68 ESR
-| datareporting.policy.dataSubmissionPolicyBypassNotification | boolean | Firefox 68, Firefox 68 ESR
-| dom.disable_window_flip | boolean | Firefox 68, Firefox 68 ESR
-| dom.disable_window_move_resize | boolean | Firefox 68, Firefox 68 ESR
-| dom.event.contextmenu.enabled | boolean | Firefox 68, Firefox 68 ESR
-| dom.keyboardevent.keypress.hack.dispatch_non_printable_keys.addl | string | Firefox 68, Firefox 68 ESR
-| dom.keyboardevent.keypress.hack.use_legacy_keycode_and_charcode.addl | string | Firefox 68, Firefox 68 ESR
-| extensions.getAddons.showPane | boolean | Firefox 68, Firefox 68 ESR
-| media.gmp-gmpopenh264.enabled | boolean | Firefox 68, Firefox 68 ESR
-| media.gmp-widevinecdm.enabled | boolean | Firefox 68, Firefox 68 ESR
-| network.dns.disableIPv6 | boolean | Firefox 68, Firefox 68 ESR
-| network.IDN_show_punycode | boolean | Firefox 68, Firefox 68 ESR
-| places.history.enabled | boolean | Firefox 68, Firefox 68 ESR
-| security.default_personal_cert | string | Firefox 68, Firefox 68 ESR
-| security.ssl.errorReporting.enabled | boolean | Firefox 68, Firefox 68 ESR
-| ui.key.menuAccessKeyFocuses | boolean | Firefox 68, Firefox 68 ESR
+| Preference | Type | Compatibility | Default
+| --- | --- | --- | ---
+| app.update.auto | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, Firefox doesn't automatically install update.
+| browser.cache.disk.enable | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, don't store cache on the hard drive.
+| browser.cache.disk.parent_directory | string | Firefox 68, Firefox 68 ESR | Profile temporary directory
+| &nbsp;&nbsp;&nbsp;&nbsp;If set, changes the location of the disk cache.
+| browser.fixup.dns_first_for_single_words | boolean | Firefox 68, Firefox 68 ESR | false
+| &nbsp;&nbsp;&nbsp;&nbsp;If true, single words are sent to DNS, not directly to search.
+| browser.search.update | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, updates for search engines are not checked.
+| browser.tabs.warnOnClose | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, there is no warning when the browser is closed.
+| browser.urlbar.suggest.bookmark | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, bookmarks aren't suggested when typing in the URL bar.
+| browser.urlbar.suggest.history | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, history isn't suggested when typing in the URL bar.
+| browser.urlbar.suggest.openpage | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, open tabs aren't suggested when typing in the URL bar.
+| datareporting.policy.dataSubmissionPolicyBypassNotification | boolean | Firefox 68, Firefox 68 ESR | false
+| &nbsp;&nbsp;&nbsp;&nbsp;If true, don't show the privacy policy tab on first run.
+| dom.disable_window_flip | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, web pages can focus and activate windows.
+| dom.disable_window_move_resize | boolean | Firefox 68, Firefox 68 ESR | false
+| &nbsp;&nbsp;&nbsp;&nbsp;If true, web pages can't move or resize windows.
+| dom.event.contextmenu.enabled | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, web pages can't override context menus.
+| dom.keyboardevent.keypress.hack.dispatch_non_printable_keys.addl | string | Firefox 68, Firefox 68 ESR | N/A
+| &nbsp;&nbsp;&nbsp;&nbsp;See https://support.mozilla.org/en-US/kb/dom-events-changes-introduced-firefox-66
+| dom.keyboardevent.keypress.hack.use_legacy_keycode_and_charcode.addl | string | Firefox 68, Firefox 68 ESR | N/A
+| &nbsp;&nbsp;&nbsp;&nbsp;See https://support.mozilla.org/en-US/kb/dom-events-changes-introduced-firefox-66
+| extensions.getAddons.showPane | boolean | Firefox 68, Firefox 68 ESR | N/A
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, the Recommendations tab is not displayed in the Add-ons Manager.
+| media.gmp-gmpopenh264.enabled | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, the OpenH264  plugin is not downloaded.
+| media.gmp-widevinecdm.enabled | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, the Widevine plugin is not downloaded.
+| network.dns.disableIPv6 | boolean | Firefox 68, Firefox 68 ESR | false
+| &nbsp;&nbsp;&nbsp;&nbsp;If true, IPv6 DNS lokoups are disabled.
+| network.IDN_show_punycode | boolean | Firefox 68, Firefox 68 ESR | false
+| &nbsp;&nbsp;&nbsp;&nbsp;If true, display the punycode version of internationalized domain names. 
+| places.history.enabled | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, history is not enabled.
+| security.default_personal_cert | string | Firefox 68, Firefox 68 ESR | Ask Every Time
+| &nbsp;&nbsp;&nbsp;&nbsp;If set to Select Automatically, Firefox automatically chooses the default personal certificate.
+| security.ssl.errorReporting.enabled | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, SSL errors cannot be sent to Mozilla.
+| ui.key.menuAccessKeyFocuses | boolean | Firefox 68, Firefox 68 ESR | true
+| &nbsp;&nbsp;&nbsp;&nbsp;If false, the Alt key doesn't show the menubar on Windows.

 #### Windows
 ```
 Software\Policies\Mozilla\Firefox\Preferences\boolean_preference_name = 0x1 | 0x0
 #### Windows
 ```
 Software\Policies\Mozilla\Firefox\Preferences\boolean_preference_name = 0x1 | 0x0


@@ -2207,7 +2249,7 @@ Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2404,7 +2446,7 @@ Set the default search engine. This policy is only available on the ESR.
 **CCK2 Equivalent:** `defaultSearchEngine`\
 **Preferences Affected:** N/A
 
 **CCK2 Equivalent:** `defaultSearchEngine`\
 **Preferences Affected:** N/A
 

-### Windows
+#### Windows

 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
 ```
 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
 ```


@@ -2418,7 +2460,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2436,7 +2478,7 @@ Prevent installing search engines from webpages.
 **CCK2 Equivalent:** `disableSearchEngineInstall`\
 **Preferences Affected:** N/A
 
 **CCK2 Equivalent:** `disableSearchEngineInstall`\
 **Preferences Affected:** N/A
 

-### Windows
+#### Windows

 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
 ```
 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
 ```


@@ -2450,7 +2492,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2468,7 +2510,7 @@ Hide built-in search engines. This policy is only available on the ESR.
 **CCK2 Equivalent:** `removeDefaultSearchEngines` (removed all built-in engines)\
 **Preferences Affected:** N/A
 
 **CCK2 Equivalent:** `removeDefaultSearchEngines` (removed all built-in engines)\
 **Preferences Affected:** N/A
 

-### Windows
+#### Windows

 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
 ```
 ```
 Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
 ```


@@ -2484,7 +2526,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2519,6 +2561,7 @@ Add new search engines (up to five). This policy is only available on the ESR. `
 **Preferences Affected:** N/A
 
 #### Windows
 **Preferences Affected:** N/A
 
 #### Windows

+```

 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Name = "Example1"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\URLTemplate = "https://www.example.org/q={searchTerms}"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Method = "GET" | "POST"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Name = "Example1"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\URLTemplate = "https://www.example.org/q={searchTerms}"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Method = "GET" | "POST"


@@ -2527,6 +2570,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Alias = "example"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description = "Example Description"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "https://www.example.org/suggestions/q={searchTerms}"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\PostData = "name=value&q={searchTerms}"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description = "Example Description"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "https://www.example.org/suggestions/q={searchTerms}"
 Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\PostData = "name=value&q={searchTerms}"

+```

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


@@ -2557,7 +2601,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\PostData = "name=value&q={
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2586,7 +2630,7 @@ Enable search suggestions.
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `browser.urlbar.suggest.searches`,`browser.search.suggest.enabled`
 
 **CCK2 Equivalent:** N/A\
 **Preferences Affected:** `browser.urlbar.suggest.searches`,`browser.search.suggest.enabled`
 

-### Windows
+#### Windows

 ```
 Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
 ```
 ```
 Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
 ```


@@ -2597,7 +2641,7 @@ Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
   <true/> | <false/>
 </dict>
 ```
   <true/> | <false/>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2705,7 +2749,7 @@ Add a menuitem to the help menu for specifying support information.
 ```
 Software\Policies\Mozilla\Firefox\SupportMenu\Title = "Support Menu"
 Software\Policies\Mozilla\Firefox\SupportMenu\URL = "http://example.com/support"
 ```
 Software\Policies\Mozilla\Firefox\SupportMenu\Title = "Support Menu"
 Software\Policies\Mozilla\Firefox\SupportMenu\URL = "http://example.com/support"

-Software\Policies\Mozilla\Firefox\SupportMenu\Title = "S"
+Software\Policies\Mozilla\Firefox\SupportMenu\AccessKey = "S"

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


@@ -2721,7 +2765,7 @@ Software\Policies\Mozilla\Firefox\SupportMenu\Title = "S"
   </dict>
 </dict>
 ```
   </dict>
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {


@@ -2762,7 +2806,7 @@ Software\Policies\Mozilla\Firefox\WebsiteFilters\Exceptions\1 = "http://example.
 
 </dict>
 ```
 
 </dict>
 ```

-### JSON
+#### JSON

 ```
 {
   "policies": {
 ```
 {
   "policies": {