X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/86dfcc764f5423e4d8274064f857d6c3d7d36ed9..8654f484f0998f16a755d2d2afc20f6187b9c189:/README-new.md?ds=inline diff --git a/README-new.md b/README-new.md index 1c2fb34..8ba3e38 100644 --- a/README-new.md +++ b/README-new.md @@ -42,38 +42,111 @@ This policy is for configuring sites that support integrated authentication. See } ``` ### BlockAboutAddons -This policy removes access to about:addons. +A Boolean value that blocks access to about:addons. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableAddonsManager`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\BlockAboutAddons` | + +#### macOS +``` + + BlockAboutAddons + | + +``` +#### JSON ``` { "policies": { - "BlockAboutAddons": true + "BlockAboutAddons": true | false } } ``` ### BlockAboutConfig -This policy removes access to about:config. +A Boolean value that blocks access to about:config. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableAboutConfig`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\BlockAboutConfig` | + +#### macOS +``` + + BlockAboutConfig + | + +``` +#### JSON ``` { "policies": { - "BlockAboutConfig": true + "BlockAboutConfig": true | false } } ``` ### BlockAboutProfiles -This policy removes access to about:profiles. +A Boolean value that blocks access to about:profiles. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableAboutProfiles`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\BlockAboutProfiles` | + +#### macOS +``` + + BlockAboutProfiles + | + +``` +#### JSON ``` { "policies": { - "BlockAboutProfiles": true + "BlockAboutProfiles": true | false } } ``` ### BlockAboutSupport -This policy removes access to about:support. +A Boolean value that blocks access to about:support. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableAboutSupport`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\BlockAboutSupport` | + +#### macOS +``` + + BlockAboutSupport + | + +``` +#### JSON ``` { "policies": { - "BlockAboutSupport": true + "BlockAboutSupport": true | false + } } ``` ### Bookmarks @@ -114,7 +187,6 @@ A Boolean value that enables or disables captive portal support by setting and l | ``` - #### JSON ``` { @@ -193,145 +265,433 @@ This policy configures DNS over HTTPS. ``` ### DisableSetDesktopBackground This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `removeSetDesktopBackground`\ +**Preferences Affected:** `devtools.policy.disabled` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableSetDesktopBackground` | + +#### macOS +``` + + DisableSetDesktopBackground + | + +``` +#### JSON ``` { "policies": { - "DisableSetDesktopBackground": true + "DisableSetDesktopBackground": true | false } } ``` ### DisableMasterPasswordCreation If this policy is set to true, the master password functionality is removed. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `noMasterPassword`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableMasterPasswordCreation` | + +#### macOS +``` + + DisableMasterPasswordCreation + | + +``` +#### JSON ``` { "policies": { - "DisableMasterPasswordCreation": [true|false] + "DisableMasterPasswordCreation": true | false } } ``` ### DisableAppUpdate This policy turns off application updates. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableFirefoxUpdates`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableAppUpdate` | + +#### macOS +``` + + DisableAppUpdate + | + +``` +#### JSON ``` { "policies": { - "DisableAppUpdate": true + "DisableAppUpdate": true | false } } ``` ### DisableBuiltinPDFViewer This policy disables the built in PDF viewer. PDF files are downloaded and sent externally. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disablePDFjs`\ +**Preferences Affected:** `pdfjs.disabled` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableBuiltinPDFViewer` | + +#### macOS +``` + + DisableBuiltinPDFViewer + | + +``` +#### JSON ``` { "policies": { - "DisableBuiltinPDFViewer": true + "DisableBuiltinPDFViewer": true | false } } ``` ### DisableDeveloperTools This policy removes access to all developer tools. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `removeDeveloperTools`\ +**Preferences Affected:** `devtools.policy.disabled` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableDeveloperTools` | + +#### macOS +``` + + DisableDeveloperTools + | + +``` +#### JSON ``` { "policies": { - "DisableDeveloperTools": true + "DisableDeveloperTools": true | false } } ``` ### DisableFeedbackCommands This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site). + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableFeedbackCommands` | + +#### macOS +``` + + DisableFeedbackCommands + | + +``` +#### JSON ``` { "policies": { - "DisableFeedbackCommands": true + "DisableFeedbackCommands": true | false } } ``` ### DisableFirefoxScreenshots This policy removes access to Firefox Screenshots. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `extensions.screenshots.disabled` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableFirefoxScreenshots` | + +#### macOS +``` + + DisableFirefoxScreenshots + | + +``` +#### JSON ``` { "policies": { - "DisableFirefoxScreenshots": true + "DisableFirefoxScreenshots": true | false } } ``` ### DisableFirefoxAccounts -This policy disables Sync. +A boolean possibly that disables sync. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableSync`\ +**Preferences Affected:** `identity.fxaccounts.enabled` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableFirefoxAccounts` | + +#### macOS +``` + + DisableFirefoxAccounts + | + +``` +#### JSON ``` { "policies": { - "DisableFirefoxAccounts": true + "DisableFirefoxAccounts": true | false } } ``` ### DisableFirefoxStudies This policy disables Firefox studies (Shield). + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableForget`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableFirefoxStudies` | + +#### macOS +``` + + DisableFirefoxStudies + | + +``` +#### JSON ``` { "policies": { - "DisableFirefoxStudies": true + "DisableFirefoxStudies": true | false } } ``` ### DisableForgetButton -This policy disables the "Forget" button. +This policy turns disables the "Forget" button. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableForget`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableForgetButton` | + +#### macOS +``` + + DisableForgetButton + | + +``` +#### JSON ``` { "policies": { - "DisableForgetButton": true + "DisableForgetButton": true | false } } ``` ### DisableFormHistory -This policy turns off the browser.formfill.enable preferences. +This policy turns off saving information on web forms and the search bar. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableFormFill`\ +**Preferences Affected:** ` browser.formfill.enable` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableFormHistory` | + +#### macOS +``` + + DisableFormHistory + | + +``` +#### JSON ``` { "policies": { - "DisableFormHistory": true + "DisableFormHistory": true | false } } ``` ### DisablePocket -This policy turns off Pocket. +This policy removes Pocket in the Firefox UI. It does not remove it from the new tab page. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disablePocket`\ +**Preferences Affected:** `extensions.pocket.enabled` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisablePocket` | + +#### macOS +``` + + DisablePocket + | + +``` +#### JSON ``` { "policies": { - "DisablePocket": true + "DisablePocket": true | false } } ``` ### DisablePrivateBrowsing This policy removes access to private browsing. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disablePrivateBrowsing`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisablePrivateBrowsing` | + +#### macOS +``` + + DisablePrivateBrowsing + | + +``` +#### JSON ``` { "policies": { - "DisablePrivateBrowsing": true + "DisablePrivateBrowsing": true | false } } ``` ### DisableProfileImport This policy disables the "Import data from another browser" option in the bookmarks window. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableProfileImport` | + +#### macOS +``` + + DisableProfileImport + | + +``` +#### JSON ``` { "policies": { - "DisableProfileImport": true + "DisableProfileImport": true | false } } ``` ### DisableProfileRefresh -This policy disables the Refresh Firefox button on about:support and support.mozilla.org. +This policy disables the Refresh Firefox button on about:support and support.mozilla.org, as well as the prompt that displays offering to refresh Firefox when you haven't used it in a while. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableResetFirefox`\ +**Preferences Affected:** `browser.disableResetPrompt` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableProfileRefresh` | + +#### macOS +``` + + DisableProfileRefresh + | + +``` +#### JSON ``` { "policies": { - "DisableProfileRefresh": true + "DisableProfileRefresh": true | false } } ``` ### DisableSafeMode -This policy disables safe mode on Windows and macOS only. +This boolean value disables safe mode. + +**Compatibility:** Firefox 60, Firefox ESR 60 (Windows, macOS)\ +**CCK2 Equivalent:** `disableSafeMode`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableSafeMode` | + +#### macOS +``` + + DisableSafeMode + | + +``` +#### JSON ``` { "policies": { - "DisableSafeMode": true + "DisableSafeMode": true | false } } ``` @@ -348,49 +708,139 @@ This policy prevents the user from bypassing security in certain cases. } ``` ### DisableSystemAddonUpdate -This policy prevents system add-ons from being updated or installed. +This boolean value prevents system add-ons from being updated or installed. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableSystemAddonUpdate` | + +#### macOS +``` + + DisableSystemAddonUpdate + | + +``` +#### JSON ``` { "policies": { - "DisableSystemAddonUpdate": true + "DisableSystemAddonUpdate": true | false } } ``` ### DisableTelemetry -This policy prevents the upload of telemetry data. +This boolean value prevents the upload of telemetry data. Mozilla recommends that you do not disable telemetry. Information collected through telemetry helps us build a better product for businesses like yours. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableTelemetry`\ +**Preferences Affected:** `datareporting.healthreport.uploadEnabled,datareporting.policy.dataSubmissionEnabled` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisableTelemetry` | + +#### macOS +``` + + DisableTelemetry + | + +``` +#### JSON ``` { "policies": { - "DisableTelemetry": true + "DisableTelemetry": true | false } } ``` ### DisplayBookmarksToolbar -This policy turns on the bookmarks toolbar by default. A user can still turn it off, and it will stay off. +This boolean value turns on the bookmarks toolbar by default. A user can still turn it off, and it will stay off. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `displayBookmarksToolbar`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisplayBookmarksToolbar` | + +#### macOS +``` + + DisplayBookmarksToolbar + | + +``` +#### JSON ``` { "policies": { - "DisplayBookmarksToolbar": true + "DisplayBookmarksToolbar": true | false } } ``` -### DisplayMenuBar -This policy turns on the menubar by default. A user can still turn it off, and it will stay off. +### DontCheckDefaultBrowser +This boolean value turns on the menubar by default. A user can still turn it off, and it will stay off. + +**Compatibility:** Firefox 60, Firefox ESR 60 (Windows, some Linux)\ +**CCK2 Equivalent:** `displayMenuBar`\ +**Preferences Affected:** N/~ + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DisplayMenuBar` | + +#### macOS +``` + + DisplayMenuBar + | + +``` +#### JSON ``` { "policies": { - "DisplayMenuBar": true + "DisplayMenuBar": true | false } } ``` ### DontCheckDefaultBrowser -This policy stops Firefox from checking if it is the default browser at startup. +This boolean value stops Firefox from checking if it is the default browser at startup. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `dontCheckDefaultBrowser`\ +**Preferences Affected:** `browser.shell.checkDefaultBrowser` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\DontCheckDefaultBrowser` | + +#### macOS +``` + + DontCheckDefaultBrowser + | + +``` +#### JSON ``` { "policies": { - "DontCheckDefaultBrowser": true + "DontCheckDefaultBrowser": true | false } } ``` @@ -429,37 +879,110 @@ For Uninstall and Locked, you specify extension IDs. } ``` ### ExtensionUpdate -This policy enables or disables extension updates by setting and locking the preference `extensions.update.enabled`. +This boolean value determines extension update are enabled. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `extensions.update.enabled` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\ExtensionUpdate` | + +#### macOS +``` + + ExtensionUpdate + | + +``` +#### JSON ``` { "policies": { - "ExtensionUpdate": [true|false] + "ExtensionUpdate": true | false + } } ``` ### HardwareAcceleration -This policy disables hardware acceleration by locking the preference layers.acceleration.disabled to true. +This boolean value determines if hardware acceleration is enabled. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `layers.acceleration.disabled` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\HardwareAcceleration` | + +#### macOS +``` + + HardwareAcceleration + | + +``` +#### JSON ``` { "policies": { - "HardwareAcceleration": false + "HardwareAcceleration": true | false } } ``` ### NoDefaultBookmarks -This policy prevents the default bookmarks or the Smart Bookmarks (Most Visited, Recent Tags) from being created. Note: this policy is only effective if used before the first run of the profile. +A Boolean value that prevents the default bookmarks and Smart Bookmarks (Most Visited, Recent Tags) from being created. Note: this policy is only effective if used before the first run of the profile. Also, the smart bookmarks were removed in Firefox 63. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `removeDefaultBookmarks`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\NoDefaultBookmarks` | + +#### macOS +``` + + NoDefaultBookmarks + | + +``` +#### JSON ``` { "policies": { - "NoDefaultBookmarks": true + "NoDefaultBookmarks": true | false } } ``` ### OfferToSaveLogins -This policy sets the signon.rememberSignons preference. It determines whether or not Firefox offers to save passwords. It can either be enabled or disabled. +This boolean value determines whether or not Firefox offers to save passwords. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `dontRememberPasswords`\ +**Preferences Affected:** `signon.rememberSignons` + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\OfferToSaveLogins` | + +#### macOS +``` + + OfferToSaveLogins + | + +``` +#### JSON ``` { "policies": { - "OfferToSaveLogins": true + "OfferToSaveLogins": true | false } } ``` @@ -602,6 +1125,89 @@ To specify ports, append them to the hostnames with a colon (:). If Locked is se } } ``` +**Compatibility:** Firefox ESR 60\ +**CCK2 Equivalent:** `networkProxy*`\ +**Preferences Affected:** N/A + +### Keys +| Key | Type | Default | Description | +| --- | ---- | ------- | ----------- | +| `Mode` | String | _required_ | The name of the search engine. | +| `Locked` | Boolean | _required_ | Search URL with {searchTerms} to substitute for the search term. | +| `HTTPProxy` | String | GET | GET or POST | +| `UseHTTPProxyForAllProtocols` | Boolean | — | URL for the icon to use. | +| `SSLProxy` | String | — | Keyword to use for the engine. | +| `FTPProxy` | String | —| Description of the search engine. | +| `SOCKSProxy` | String | — | Search suggestions URL with {searchTerms} to substitute for the search term. | +| `SOCKSVersion` | String | — | Search suggestions URL with {searchTerms} to substitute for the search term. | +| `Passthrough` | String | — | Search suggestions URL with {searchTerms} to substitute for the search term. | +| `AutoConfigURL` | String | — | Search suggestions URL with {searchTerms} to substitute for the search term. | +| `AutoLogin` | Boolean | — | Search suggestions URL with {searchTerms} to substitute for the search term. | +| `UseProxyForDNS` | Boolean | — | Search suggestions URL with {searchTerms} to substitute for the search term. | + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\Mode` | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\Locked` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\HTTPProxy` | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\UseHTTPProxyForAllProtocols` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\SSLProxy` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\FTPProxy` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\SOCKSProxy` | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\SOCKSVersion` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\Passthrough` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\AutoConfigURL` | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\AutoLogin` | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\SearchEngines\Proxy\UseProxyForDNS` | + +#### macOS +``` + + Search + + Proxy + + + Mode + none | system | manual | autoDetect| autoConfig + Locked + | + HTTPProxy + https://httpproxy.example.com + UseHTTPProxyForAllProtocols + | + SSLProxy + https://sslproxy.example.com + FTPProxy + https://ftpproxy.example.com + SOCKSProxy + https://socksproxy.example.com + + + + +``` +### JSON +``` +{ + "policies": { + "SearchEngines": { + "Add": [ + { + "Name": "", + "URLTemplate": "URL including {searchTerms} to substitute for the terms", + "Method": ["GET", "POST"], + "IconURL": "URL to icon", + "Alias": "Alias that can be used to access the engine", + "Description": "Description", + "SuggestURLTemplate": "URL for suggestions using {searchTerms}" + } + ] + } + } +} +``` ### RequestedLocales This policy sets the list of requested locales for the application in order of preference. It will cause the corresponding language pack to become active. ``` @@ -612,6 +1218,33 @@ This policy sets the list of requested locales for the application in order of p } ``` ### SanitizeOnShutdown +A boolean value that tells Firefox to 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` +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_DWORD` | `Software\Policies\Mozilla\Firefox\SanitizeOnShutdown` | + +#### macOS +``` + + SanitizeOnShutdown + | + +``` + +#### JSON +``` +{ + "policies": { + "SanitizeOnShutdown": true | false + } +} +``` +### SanitizeOnShutdown If this policy is set to true, all data is cleared when Firefox is closed. This includes Browsing & Download History, Cookies, Active Logins, Cache, Form & Search History, Site Preferences and Offline Website Data. ``` { @@ -621,11 +1254,30 @@ If this policy is set to true, all data is cleared when Firefox is closed. This } ``` ### SearchBar -This policy can be used to determine if the search bar is separate or combined with the URL bar. +A String value that sets whether or not the search bar is displayed. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `showSearchBar`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchBar` | + +#### macOS +``` + + SearchBar + unified | separate + +``` + +#### JSON ``` { "policies": { - "SearchBar": ["unified", "separate"] + "SearchBar": "unified" | "separate" } } ``` @@ -644,6 +1296,77 @@ This policy blocks websites from being visited. The parameters take an array of ### Search Engines (This policy is only available on the ESR.) This policy allows you to add new search engines, remove or hide search engines, as well as set the default and prevent the install of search engines from web pages. Only Name and URLTemplate is required. ``` +{ + "policies": { + "SearchEngines": { + "Default": "Name of engine", + "PreventInstalls": [true|false], + "Remove": ["Twitter", "Wikipedia (en)"] + } + } +} +``` +### Search Engines + +### Search Engines | Add + +This policy allows you to add up to five new search engines. This policy is only available on the ESR. + +**Compatibility:** Firefox ESR 60\ +**CCK2 Equivalent:** `config.searchplugins`\ +**Preferences Affected:** N/A + +### Keys +| Key | Type | Default | Description | +| --- | ---- | ------- | ----------- | +| `Name` | String | _required_ | The name of the search engine. | +| `URLTemplate` | String | _required_ | Search URL with {searchTerms} to substitute for the search term. | +| `Method` | String | GET | GET or POST | +| `IconURL` | String | — | URL for the icon to use. | +| `Alias` | String | — | Keyword to use for the engine. | +| `Description` | String | —| Description of the search engine. | +| `SuggestURLTemplate` | String | — | Search suggestions URL with {searchTerms} to substitute for the search term. | + +#### Windows +| Type | Registry Location | +| ---- | ----------------- | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Name` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\URLTemplate` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Method` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\IconURL` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Alias` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\Description` | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SearchEngines\Add\1\SuggestURLTemplate` | + +#### macOS +``` + + Search + + Add + + + Name + Example1 + URLTemplate + https://www.example.org + Method + https://www.example.org/favicon.ico + IconURL + toolbar + Alias + Example1Folder + Description + Example1Folder + Alias + SuggestURLTemplate + + + + +``` +### JSON +``` { "policies": { "SearchEngines": { @@ -657,16 +1380,35 @@ This policy allows you to add new search engines, remove or hide search engines, "Description": "Description", "SuggestURLTemplate": "URL for suggestions using {searchTerms}" } - ], - "Default": "Name of engine", - "PreventInstalls": [true|false], - "Remove": ["Twitter", "Wikipedia (en)"] + ] } } } ``` ### SecurityDevices -This policy allows you to add PKCS #11 Modules +A dictionary with the names and locations of PKCS #11 modules to be installed. + +**Compatibility:** Firefox 64, Firefox ESR 60.4\ +**CCK2 Equivalent:** `certs.devices`\ +**Preferences Affected:** N/A + +#### Windows +| Type | Registry Location | Registry Value | +| ---- | ----------------- | -------------- | +| `Windows:REG_SZ` | `Software\Policies\Mozilla\Firefox\SecurityDevices\NAME_OF_DEVICE` | `PATH_TO_LIBRARY_FOR_DEVICE` + +#### macOS +``` + + SecurityDevices + + NAME_OF_DEVICE + PATH_TO_LIBRARY_FOR_DEVICE + + +``` + +#### JSON ``` { "policies": { @@ -679,7 +1421,7 @@ This policy allows you to add PKCS #11 Modules ### SSLVersionMax A String value that sets and locks the maximum version of TLS -**Compatibility:** Firefox 67, Firefox ESR 60.7\ +**Compatibility:** Firefox 66, Firefox ESR 60.6\ **CCK2 Equivalent:** N/A\ **Preferences Affected:** `security.tls.version.max` @@ -692,7 +1434,7 @@ A String value that sets and locks the maximum version of TLS ``` SSLVersionMax - tls1 | tls1.1 | tls1.2 | tls1.3 + tls1 | tls1.1 | tls1.2 | tls1.3 ``` @@ -707,7 +1449,7 @@ A String value that sets and locks the maximum version of TLS ### SSLVersionMin A String value that sets and locks the minimum version of TLS -**Compatibility:** Firefox 67, Firefox ESR 60.7\ +**Compatibility:** Firefox 66, Firefox ESR 60.6\ **CCK2 Equivalent:** N/A\ **Preferences Affected:** `security.tls.version.min` @@ -720,7 +1462,7 @@ A String value that sets and locks the minimum version of TLS ``` SSLVersionMin - tls1 | tls1.1 | tls1.2 | tls1.3 + tls1 | tls1.1 | tls1.2 | tls1.3 ```