-**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.
| **[`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.
<string>https://yoursite.com</string>
</dict>
```
-### JSON
+#### JSON
```
{
"policies": {
</dict>
</dict>
```
-### JSON
+#### JSON
```
{
"policies": {
</array>
</dict>
```
-### JSON
+#### JSON
```
{
"policies": {
#### 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
```
<dict>
- <key>Cookies</key>
+ <key>DNSOverHTTPS</key>
<dict>
<key>Enabled</key>
<true/> | <false/>
<string>${home}/Downloads</string>
</dict>
```
-#### JSON
+#### JSON (macOS and Linux)
```
{
"policies": {
"DefaultDownloadDirectory": "${home}/Downloads"
}
```
+#### JSON (Windows)
+```
+{
+ "policies": {
+ "DefaultDownloadDirectory": "${home}\\Downloads"
+}
+```
### DownloadDirectory
Set and lock the download directory.
<string>${home}/Downloads</string>
</dict>
```
-#### JSON
+#### JSON (macOS and Linux)
```
{
"policies": {
"DownloadDirectory": "${home}/Downloads"
}
```
+#### JSON (Windows)
+```
+{
+ "policies": {
+ "DownloadDirectory": "${home}\\Downloads"
+}
+```
### EnableTrackingProtection
Configure tracking protection.
### 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, 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.
+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.
| `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 string 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
+| `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 68, Firefox ESR 68\
+**Compatibility:** Firefox 69, Firefox ESR 68.1\
**CCK2 Equivalent:** N/A\
**Preferences Affected:** N/A
#### Windows
-Due to a bug in Firefox 68, this policy is not working via GPO on Windows. We will have a fix soon.
+```
+Software\Policies\Mozilla\Firefox\ExtensionSettings = '{"*": {"installation_mode": "blocked"}}'
+```
#### macOS
```
<dict>
}
}
```
-
### ExtensionUpdate
Control extension updates.
**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
`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`
</dict>
</dict>
```
-### JSON
+#### JSON
```
{
"policies": {
**CCK2 Equivalent:** `defaultSearchEngine`\
**Preferences Affected:** N/A
-### Windows
+#### Windows
```
Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE
```
</dict>
</dict>
```
-### JSON
+#### JSON
```
{
"policies": {
**CCK2 Equivalent:** `disableSearchEngineInstall`\
**Preferences Affected:** N/A
-### Windows
+#### Windows
```
Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0
```
</dict>
</dict>
```
-### JSON
+#### JSON
```
{
"policies": {
**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
```
</dict>
</dict>
```
-### JSON
+#### JSON
```
{
"policies": {
**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\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
```
</dict>
</dict>
```
-### JSON
+#### JSON
```
{
"policies": {
**CCK2 Equivalent:** N/A\
**Preferences Affected:** `browser.urlbar.suggest.searches`,`browser.search.suggest.enabled`
-### Windows
+#### Windows
```
Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0
```
<true/> | <false/>
</dict>
```
-### JSON
+#### JSON
```
{
"policies": {
}
}
```
+### 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
+```
+<dict>
+ <key>SupportMenu</key>
+ <dict>
+ <key>Title</key>
+ <string>SupportMenu</string>
+ <key>URL</key>
+ <string>http://example.com/support</string>
+ <key>AccessKey</key>
+ <string>S</string>
+ </dict>
+</dict>
+```
+#### 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.
</dict>
```
-### JSON
+#### JSON
```
{
"policies": {
git.p6c8.net / policy-templates.git / blobdiff