X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/7d06d2ee410a3bf288aff58d80049bbb07343d9e..6d7132134300fbdfe7b3325d8c906e37f0f426e8:/README.md?ds=inline diff --git a/README.md b/README.md index e036206..60cc86f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -**IMPORTANT**: This file is in active development along with the policies in Firefox. Make sure to check the compatibility section to see if a policy is available in a specific version of Firefox. To get the policy information that corresponds to a specific release, go to https://github.com/mozilla/policy-templates/releases. +**These policies are in active development and so might contain changes that do not work with current versions of Firefox.** + +**You should use the officially released versions (https://github.com/mozilla/policy-templates/releases) if you are deploying changes.** Policies can be specified using the Group Policy templates on Windows (https://github.com/mozilla/policy-templates/tree/master/windows), configuration profiles on macOS (https://github.com/mozilla/policy-templates/tree/master/mac), or by creating a file called `policies.json`. On Windows, create a directory called `distribution` where the EXE is located and place the file there. On Mac, the file goes into `Firefox.app/Contents/Resources/distribution`. On Linux, the file goes into `firefox/distribution`, where `firefox` is the installation directory for firefox, which varies by distribution. @@ -36,16 +38,23 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`DisableSystemAddonUpdate`](#disablesystemaddonupdate)** | Prevent system add-ons from being installed or update. | **[`DisableTelemetry`](#disabletelemetry)** | DisableTelemetry | **[`DisplayBookmarksToolbar`](#displaybookmarkstoolbar)** | Set the initial state of the bookmarks toolbar. -| **[`DisplayMenuBar`](#displaymenubar)** | Set the initial state of the menubar +| **[`DisplayMenuBar`](#displaymenubar)** | Set the initial state of the menubar. | **[`DNSOverHTTPS`](#dnsoverhttps)** | Configure DNS over HTTPS. | **[`DontCheckDefaultBrowser`](#dontcheckdefaultbrowser)** | Don't check if Firefox is the default browser at startup. +| **[`DefaultDownloadDirectory`](#defaultdownloaddirectory)** | Set the default download directory. +| **[`DownloadDirectory`](#downloaddirectory)** | Set and lock the download directory. | **[`EnableTrackingProtection`](#enabletrackingprotection)** | Configure tracking protection. +| **[`EnterprisePoliciesEnabled`](#enterprisepoliciesenabled)** | Enable policy support on macOS. | **[`Extensions`](#extensions)** | Control the installation, uninstallation and locking of extensions. +| **[`ExtensionSettings`](#extensionsettings)** | Manage all aspects of extensions. | **[`ExtensionUpdate`](#extensionupdate)** | Control extension updates. | **[`FlashPlugin`](#flashplugin)** | Configure the default Flash plugin policy as well as origins for which Flash is allowed. +| **[`FirefoxHome`](#firefoxhome)** | Customize the Firefox Home page. | **[`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. | **[`NoDefaultBookmarks`](#nodefaultbookmarks)** | Disable the creation of default bookmarks. @@ -55,9 +64,11 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`Permissions`](#permissions)** | Set permissions associated with camera, microphone, location, and notifications. | **[`PopupBlocking`](#popupblocking)** | Configure the default pop-up window policy as well as origins for which pop-up windows are allowed. | **[`Preferences`](#preferences)** | Set and lock some preferences. +| **[`PromptForDownloadLocation`](#promptfordownloadlocation)** | Ask where to save each file before downloading. | **[`Proxy`](#proxy)** | Configure proxy settings. | **[`RequestedLocales`](#requestedlocales)** | Set the the list of requested locales for the application in order of preference. -| **[`SanitizeOnShutdown`](#sanitizeonshutdown)** | Clear all data on shutdown. +| **[`SanitizeOnShutdown` (All)](#sanitizeonshutdown-all)** | Clear all data on shutdown. +| **[`SanitizeOnShutdown` (Selective)](#sanitizeonshutdown-selective)** | Clear data on shutdown. | **[`SearchBar`](#searchbar)** | Set whether or not search bar is displayed. | **[`SearchEngines`](#searchengines-this-policy-is-only-available-on-the-esr)** | | **[`SearchEngines -> Default`](#searchengines--default)** | Set the default search engine. @@ -65,11 +76,12 @@ Policies can be specified using the Group Policy templates on Windows (https://g | **[`SearchEngines -> Remove`](#searchengines--remove)** | Hide built-in search engines. | **[`SearchEngines -> Add`](#searchengines--add)** | Add new search engines. | **[`SecurityDevices`](#securitydevices)** | Install PKCS #11 modules. +| **[`SearchSuggestEnabled`](#searchsuggestenabled)** | Enable search suggestions. | **[`SSLVersionMax`](#sslversionmax)** | Set and lock the maximum version of TLS. | **[`SSLVersionMin`](#sslversionmin)** | Set and lock the minimum version of TLS. +| **[`SupportMenu`](#supportmenu)** | Add a menuitem to the help menu for specifying support information. | **[`WebsiteFilter`](#websitefilter)** | Block websites from being visited. - ### AppUpdateURL Change the URL for application update. @@ -89,7 +101,7 @@ Software\Policies\Mozilla\Firefox\AppUpdateURL = "https://yoursite.com" https://yoursite.com ``` -### JSON +#### JSON ``` { "policies": { @@ -148,7 +160,7 @@ Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\NTLM = 0x1 | 0x0 ``` -### JSON +#### JSON ``` { "policies": { @@ -308,7 +320,7 @@ Software\Policies\Mozilla\Firefox\Bookmarks\1\Folder = "FolderName" ``` -### JSON +#### JSON ``` { "policies": { @@ -1095,14 +1107,14 @@ Configure DNS over HTTPS. #### Windows ``` -Software\Policies\Mozilla\Firefox\Cookies\Enabled = 0x1 | 0x0 -Software\Policies\Mozilla\Firefox\Cookies\ProviderURL = "URL_TO_ALTERNATE_PROVIDER" -Software\Policies\Mozilla\Firefox\Cookies\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Enabled = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\DNSOverHTTPS\ProviderURL = "URL_TO_ALTERNATE_PROVIDER" +Software\Policies\Mozilla\Firefox\DNSOverHTTPS\Locked = 0x1 | 0x0 ``` #### macOS ``` - Cookies + DNSOverHTTPS Enabled | @@ -1151,6 +1163,74 @@ Software\Policies\Mozilla\Firefox\DontCheckDefaultBrowser = 0x1 | 0x0 } } ``` +### DefaultDownloadDirectory +Set the default download directory. + +You can use ${home} for the native home directory. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `browser.download.dir`,`browser.download.folderList` + +#### Windows +``` +Software\Policies\Mozilla\Firefox\DefaultDownloadDirectory = "${home}\Downloads" +``` +#### macOS +``` + + DefaultDownloadDirectory + ${home}/Downloads + +``` +#### JSON (macOS and Linux) +``` +{ + "policies": { + "DefaultDownloadDirectory": "${home}/Downloads" +} +``` +#### JSON (Windows) +``` +{ + "policies": { + "DefaultDownloadDirectory": "${home}\\Downloads" +} +``` +### DownloadDirectory +Set and lock the download directory. + +You can use ${home} for the native home directory. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `browser.download.dir`,`browser.download.folderList`,`browser.download.useDownloadDir` + +#### Windows +``` +Software\Policies\Mozilla\Firefox\DownloadDirectory = "${home}\Downloads" +``` +#### macOS +``` + + DownloadDirectory + ${home}/Downloads + +``` +#### JSON (macOS and Linux) +``` +{ + "policies": { + "DownloadDirectory": "${home}/Downloads" +} +``` +#### JSON (Windows) +``` +{ + "policies": { + "DownloadDirectory": "${home}\\Downloads" +} +``` ### EnableTrackingProtection Configure tracking protection. @@ -1192,6 +1272,20 @@ Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Locked = 0x1 | 0x0 } } ``` +### EnterprisePoliciesEnabled +Enable policy support on macOS. + +**Compatibility:** Firefox 63, Firefox ESR 60.3 (macOS only)\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### macOS +``` + + EnterprisePoliciesEnabled + + +``` ### Extensions Control the installation, uninstallation and locking of extensions. @@ -1247,6 +1341,79 @@ Software\Policies\Mozilla\Firefox\Extensions\Locked\1 = "addon_id@mozilla.org" } } ``` +### ExtensionSettings +Manage all aspects of extensions. This policy is based heavily on the [Chrome policy](https://dev.chromium.org/administrators/policy-list-3/extension-settings-full) of the same name. + +This policy maps an extension ID to its configuration. With an extension ID, the configuration will be applied to the specified extension only. A default configuration can be set for the special ID "*", which will apply to all extensions that don't have a custom configuration set in this policy. + +To obtain an extension ID, install the extension and go to about:support. You will see the ID in the Extensions section. + +The configuration for each extension is another dictionary that can contain the fields documented below. + +| Name | Description | +| --- | --- | +| `installation_mode` | Maps to a string indicating the installation mode for the extension. The valid strings are `allowed`,`blocked`,`force_installed`, and `normal_installed`. +|         `allowed` | Allows the extension to be installed by the user. This is the default behavior. +|         `blocked`| Blocks installation of the extension and removes it from the device if already installed. +|         `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. +|         `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 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. If installing frmo the local file system, use a file:/// URL. +| `install_sources` | 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", "langpack" 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. + +**Compatibility:** Firefox 69, Firefox ESR 68.1\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows +``` +Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) = '{"*": {"installation_mode": "blocked"}}' +``` +#### macOS +``` + + ExtensionSettings + + * + + blocked_install_message + Custom error message. + install_sources + + https://addons.mozilla.org/ + + installation_mode + blocked + + uBlock0@raymondhill.net + + installation_mode + force_installed + install_url + https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi + + + +``` +#### JSON +``` +{ + "policies": { + "ExtensionSettings": { + "*": { + "blocked_install_message": "Custom error message.", + "install_sources": ["https://addons.mozilla.org/"], + "installation_mode": "blocked" + }, + "uBlock0@raymondhill.net": { + "installation_mode": "force_installed", + "install_url": "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi" + } + } + } +} +``` ### ExtensionUpdate Control extension updates. @@ -1328,6 +1495,57 @@ Software\Policies\Mozilla\Firefox\FlashPlugin\Locked = 0x1 | 0x0 } } ``` +### FirefoxHome +Customize the Firefox Home page. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `browser.newtabpage.activity-stream.showSearch`,`browser.newtabpage.activity-stream.feeds.topsites`,`browser.newtabpage.activity-stream.feeds.section.highlights`,`browser.newtabpage.activity-stream.feeds.section.topstories`,`browser.newtabpage.activity-stream.feeds.snippets` + +#### Windows +``` +Software\Policies\Mozilla\Firefox\FirefoxHome\Search = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FirefoxHome\TopSites = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FirefoxHome\Highlights = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FirefoxHome\Pocket = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FirefoxHome\Snippets = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FirefoxHome\Locked = 0x1 | 0x0 +``` +#### macOS +``` + + FirefoxHome + + Search + | + TopSites + | + Highlights + | + Pocket + | + Snippets + | + Locked + | + + +``` +#### JSON +``` +{ + "policies": { + "FirefoxHome": { + "Search": true | false, + "TopSites": true | false, + "Highlights": true | false, + "Pocket": true | false, + "Snippets": true | false, + "Locked": true | false + } + } +} +``` ### HardwareAcceleration Control hardware acceleration. @@ -1454,6 +1672,54 @@ 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. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `capability.policy.localfilelinks.*` + +#### Windows +``` +Software\Policies\Mozilla\Firefox\LocalFileLinks\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\LocalFileLinks\2 = "https://example.edu" +``` +#### macOS +``` + + LocalFileLinks + + http://example.org + http://example.edu + + +``` +#### JSON +``` +{ + "policies": { + "LocalFileLinks": ["http://example.org/", + "http://example.edu/"] + } +} +``` ### NoDefaultBookmarks Disable the creation of default bookmarks. @@ -1512,7 +1778,7 @@ Enable or disable the New Tab page. **Compatibility:** Firefox 68, Firefox ESR 68\ **CCK2 Equivalent:** N/A\ -**Preferences Affected:** N/A +**Preferences Affected:** `browser.newtabpage.enabled` #### Windows ``` @@ -1580,7 +1846,7 @@ Software\Policies\Mozilla\Firefox\OverrideFirstRunPage = "http://example.org" ``` { "policies": { - "OverrideFirstRunPage": ""http://example.org"" + "OverrideFirstRunPage": "http://example.org" } ``` ### OverridePostUpdatePage @@ -1605,7 +1871,7 @@ Software\Policies\Mozilla\Firefox\OverridePostUpdatePage = "http://example.org" ``` { "policies": { - "OverridePostUpdatePage": ""http://example.org"" + "OverridePostUpdatePage": "http://example.org" } ``` ### Permissions @@ -1800,32 +2066,56 @@ Set and lock certain preferences. **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 +|     If false, Firefox doesn't automatically install update. +| browser.cache.disk.enable | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, don't store cache on the hard drive. +| browser.cache.disk.parent_directory | string | Firefox 68, Firefox 68 ESR | Profile temporary directory +|     If set, changes the location of the disk cache. +| browser.fixup.dns_first_for_single_words | boolean | Firefox 68, Firefox 68 ESR | false +|     If true, single words are sent to DNS, not directly to search. +| browser.search.update | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, updates for search engines are not checked. +| browser.tabs.warnOnClose | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, there is no warning when the browser is closed. +| browser.urlbar.suggest.bookmark | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, bookmarks aren't suggested when typing in the URL bar. +| browser.urlbar.suggest.history | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, history isn't suggested when typing in the URL bar. +| browser.urlbar.suggest.openpage | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, open tabs aren't suggested when typing in the URL bar. +| datareporting.policy.dataSubmissionPolicyBypassNotification | boolean | Firefox 68, Firefox 68 ESR | false +|     If true, don't show the privacy policy tab on first run. +| dom.disable_window_flip | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, web pages can focus and activate windows. +| dom.disable_window_move_resize | boolean | Firefox 68, Firefox 68 ESR | false +|     If true, web pages can't move or resize windows. +| dom.event.contextmenu.enabled | boolean | Firefox 68, Firefox 68 ESR | true +|     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 +|     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 +|     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 +|     If false, the Recommendations tab is not displayed in the Add-ons Manager. +| media.gmp-gmpopenh264.enabled | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, the OpenH264 plugin is not downloaded. +| media.gmp-widevinecdm.enabled | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, the Widevine plugin is not downloaded. +| network.dns.disableIPv6 | boolean | Firefox 68, Firefox 68 ESR | false +|     If true, IPv6 DNS lokoups are disabled. +| network.IDN_show_punycode | boolean | Firefox 68, Firefox 68 ESR | false +|     If true, display the punycode version of internationalized domain names. +| places.history.enabled | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, history is not enabled. +| security.default_personal_cert | string | Firefox 68, Firefox 68 ESR | Ask Every Time +|     If set to Select Automatically, Firefox automatically chooses the default personal certificate. +| security.ssl.errorReporting.enabled | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, SSL errors cannot be sent to Mozilla. +| ui.key.menuAccessKeyFocuses | boolean | Firefox 68, Firefox 68 ESR | true +|     If false, the Alt key doesn't show the menubar on Windows. #### Windows ``` Software\Policies\Mozilla\Firefox\Preferences\boolean_preference_name = 0x1 | 0x0 @@ -1834,7 +2124,7 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v #### macOS ``` - Preference + Preferences boolean_preference_name | @@ -1847,13 +2137,39 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v ``` { "policies": { - "Preference": { + "Preferences": { "boolean_preference_name": true | false, "string_preference_name": "string_value" } } } ``` +### PromptForDownloadLocation +Ask where to save each file before downloading. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A +**Preferences Affected:** `browser.download.useDownloadDir` + +#### Windows +``` +Software\Policies\Mozilla\Firefox\PromptForDownloadLocation = 0x1 | 0x0 +``` +#### macOS +``` + + PromptForDownloadLocation + | + +``` +#### JSON +``` +{ + "policies": { + "PromptForDownloadLocation": true | false + } +} +``` ### Proxy Configure proxy settings. These settings correspond to the connection settings in Firefox preferences. To specify ports, append them to the hostnames with a colon (:). @@ -1882,7 +2198,7 @@ To specify ports, append them to the hostnames with a colon (:). `UseProxyForDNS` to use proxy DNS when using SOCKS v5. -**Compatibility:** Firefoox 60, Firefox ESR 60\ +**Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** `networkProxy*`\ **Preferences Affected:** `network.proxy.type`,`network.proxy.autoconfig_url`,`network.proxy.socks_remote_dns`,`signon.autologin.proxy`,`network.proxy.socks_version`,`network.proxy.no_proxies_on`,`network.proxy.share_proxy_settings`,`network.proxy.http`,`network.proxy.http_port`,`network.proxy.ftp`,`network.proxy.ftp_port`,`network.proxy.ssl`,`network.proxy.ssl_port`,`network.proxy.socks`,`network.proxy.socks_port` @@ -1933,7 +2249,7 @@ Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0 ``` -### JSON +#### JSON ``` { "policies": { @@ -1957,13 +2273,19 @@ Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0 ### RequestedLocales Set the the list of requested locales for the application in order of preference. It will cause the corresponding language pack to become active. -**Compatibility:** Firefox 64, Firefox ESR 60.4\ +Note: For Firefox 68, this can now be a string so that you can specify an empty value. + +**Compatibility:** Firefox 64, Firefox ESR 60.4, Updated in Firefox 68, Firefox ESR 68\ **CCK2 Equivalent:** N/A\ **Preferences Affected:** N/A #### Windows ``` Software\Policies\Mozilla\Firefox\RequestedLocales\1 = "de" Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US" + +or + +Software\Policies\Mozilla\Firefox\RequestedLocales = "de,en-US" ``` #### macOS ``` @@ -1974,6 +2296,14 @@ Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US" en-US + +or + + + RequestedLocales + de,en-US + + ``` #### JSON ``` @@ -1982,13 +2312,79 @@ Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US" "RequestedLocales": ["de", "en-US"] } } + +or + +{ + "policies": { + "RequestedLocales": "de,en-US" + } +} +``` +### SanitizeOnShutdown (Selective) +Clear data on shutdown. Choose from Cache, Cookies, Download History, Form & Search History, Browsing History, Active Logins, Site Preferences and Offline Website Data. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `privacy.sanitize.sanitizeOnShutdown`,`privacy.clearOnShutdown.cache`,`privacy.clearOnShutdown.cookies`,`privacy.clearOnShutdown.downloads`,`privacy.clearOnShutdown.formdata`,`privacy.clearOnShutdown.history`,`privacy.clearOnShutdown.sessions`,`privacy.clearOnShutdown.siteSettings`,`privacy.clearOnShutdown.offlineApps` +#### Windows +``` +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Cache = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Cookies = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Downloads = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\FormData = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\History = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\Sessions = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\SiteSettings = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown\OfflineApps = 0x1 | 0x0 +``` +#### macOS +``` + + SanitizeOnShutdown + + Cache + | + Cookies + | + Downloads + | + FormData + | + History + | + Sessions + | + SiteSettings + | + OfflineApps + | + + +``` +#### JSON +``` +{ + "policies": { + "SanitizeOnShutdown": { + "Cache": true | false, + "Cookies": true | false, + "Downloads": true | false, + "FormData": true | false, + "History": true | false, + "Sessions": true | false, + "SiteSettings": true | false, + "OfflineApps": true | false + } + } +} ``` -### SanitizeOnShutdown +### SanitizeOnShutdown (All) Clear all data on shutdown, including Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data. **Compatibility:** Firefox 60, Firefox ESR 60\ **CCK2 Equivalent:** N/A\ -**Preferences Affected:** `privacy.sanitize.sanitizeOnShutdown,privacy.clearOnShutdown.cache,privacy.clearOnShutdown.cookies,privacy.clearOnShutdown.downloads,privacy.clearOnShutdown.formdata,privacy.clearOnShutdown.history,privacy.clearOnShutdown.sessions,privacy.clearOnShutdown.siteSettings,privacy.clearOnShutdown.offlineApps` +**Preferences Affected:** `privacy.sanitize.sanitizeOnShutdown`,`privacy.clearOnShutdown.cache`,`privacy.clearOnShutdown.cookies`,`privacy.clearOnShutdown.downloads`,`privacy.clearOnShutdown.formdata`,`privacy.clearOnShutdown.history`,`privacy.clearOnShutdown.sessions`,`privacy.clearOnShutdown.siteSettings`,`privacy.clearOnShutdown.offlineApps` #### Windows ``` Software\Policies\Mozilla\Firefox\SanitizeOnShutdown = 0x1 | 0x0 @@ -2050,7 +2446,7 @@ Set the default search engine. This policy is only available on the ESR. **CCK2 Equivalent:** `defaultSearchEngine`\ **Preferences Affected:** N/A -### Windows +#### Windows ``` Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE ``` @@ -2064,7 +2460,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE ``` -### JSON +#### JSON ``` { "policies": { @@ -2082,7 +2478,7 @@ Prevent installing search engines from webpages. **CCK2 Equivalent:** `disableSearchEngineInstall`\ **Preferences Affected:** N/A -### Windows +#### Windows ``` Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0 ``` @@ -2096,7 +2492,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0 ``` -### JSON +#### JSON ``` { "policies": { @@ -2114,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 -### Windows +#### Windows ``` Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE ``` @@ -2130,7 +2526,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE ``` -### JSON +#### JSON ``` { "policies": { @@ -2142,7 +2538,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE ``` ### SearchEngines | Add -Adddd new search engines (up to five). This policy is only available on the ESR. `Name` and `URLTemplate` are required. +Add new search engines (up to five). This policy is only available on the ESR. `Name` and `URLTemplate` are required. `Name` is the name of the search engine. @@ -2156,13 +2552,16 @@ Adddd new search engines (up to five). This policy is only available on the ESR. `Description` is a description of the search engine. +`PostData` is the POST data as name value pairs separated by &. + `SuggestURLTemplate` is a search suggestions URL with {searchTerms} to substitute for the search term. -**Compatibility:** Firefox ESR 60\ +**Compatibility:** Firefox ESR 60 (POST support in Firefox ESR 68)\ **CCK2 Equivalent:** `searchplugins`\ **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" @@ -2170,6 +2569,8 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\IconURL = "https://www.exa 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}" +``` #### macOS ``` @@ -2193,12 +2594,14 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "http Example Description SuggestURLTemplate https://www.example.org/suggestions/q={searchTerms} + PostData + name=value&q={searchTerms} ``` -### JSON +#### JSON ``` { "policies": { @@ -2211,6 +2614,7 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "http "IconURL": "https://www.example.org/favicon.ico", "Alias": "example", "Description": "Description", + "PostData": "name=value&q={searchTerms}", "SuggestURLTemplate": "https://www.example.org/suggestions/q={searchTerms}" } ] @@ -2218,6 +2622,33 @@ Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate = "http } } ``` +### SearchSuggestEnabled + +Enable search suggestions. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `browser.urlbar.suggest.searches`,`browser.search.suggest.enabled` + +#### Windows +``` +Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0 +``` +#### macOS +``` + + SearchSuggestEnabled + | + +``` +#### JSON +``` +{ + "policies": { + "SearchSuggestEnabled": true | false + } +} +``` ### SecurityDevices Install PKCS #11 modules. @@ -2307,6 +2738,45 @@ Software\Policies\Mozilla\Firefox\SSLVersionMin = "tls1" | "tls1.1" | "tls1.2" | } } ``` +### SupportMenu +Add a menuitem to the help menu for specifying support information. + +**Compatibility:** Firefox 68.0.1, Firefox ESR 68.0.1\ +**CCK2 Equivalent:** helpMenu\ +**Preferences Affected:** N/A + +#### Windows +``` +Software\Policies\Mozilla\Firefox\SupportMenu\Title = "Support Menu" +Software\Policies\Mozilla\Firefox\SupportMenu\URL = "http://example.com/support" +Software\Policies\Mozilla\Firefox\SupportMenu\AccessKey = "S" +``` +#### macOS +``` + + SupportMenu + + Title + SupportMenu + URL + http://example.com/support + AccessKey + S + + +``` +#### JSON +``` +{ + "policies": { + "SupportMenu": { + "Title": "Support Menu", + "URL": "http://example.com/support", + "AccessKey": "S" + } + } +} +``` ### 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. @@ -2336,7 +2806,7 @@ Software\Policies\Mozilla\Firefox\WebsiteFilters\Exceptions\1 = "http://example. ``` -### JSON +#### JSON ``` { "policies": {