X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/755fb666ed89062e52bb167578f84fe45c6fc917..b0a2ace3c195610820723a76b900ce58239ee116:/README.md diff --git a/README.md b/README.md index fc0e944..686be3d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +**IMPORTANT**: **Complete Firefox 68 policies will be released later today.** + **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. 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,13 +38,16 @@ 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. | **[`Extensions`](#extensions)** | Control the installation, uninstallation and locking 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. @@ -56,9 +61,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. @@ -1153,6 +1160,60 @@ 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 +``` +{ + "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 +``` +{ + "policies": { + "DownloadDirectory": "${home}/Downloads" +} +``` ### EnableTrackingProtection Configure tracking protection. @@ -1330,6 +1391,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. @@ -1613,7 +1725,7 @@ Software\Policies\Mozilla\Firefox\OverrideFirstRunPage = "http://example.org" ``` { "policies": { - "OverrideFirstRunPage": ""http://example.org"" + "OverrideFirstRunPage": "http://example.org" } ``` ### OverridePostUpdatePage @@ -1638,7 +1750,7 @@ Software\Policies\Mozilla\Firefox\OverridePostUpdatePage = "http://example.org" ``` { "policies": { - "OverridePostUpdatePage": ""http://example.org"" + "OverridePostUpdatePage": "http://example.org" } ``` ### Permissions @@ -1887,6 +1999,32 @@ Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_v } } ``` +### 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 (:). @@ -2016,12 +2154,70 @@ Software\Policies\Mozilla\Firefox\RequestedLocales\2 = "en-US" } } ``` -### SanitizeOnShutdown +### 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 (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