X-Git-Url: https://git.p6c8.net/policy-templates.git/blobdiff_plain/c4bd35e922f56490e9647ea35728da9b040d1388..88ca0c4977fa3052fa154d9e1db715d532f0c3c1:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 34da6c7..712a26e 100644 --- a/README.md +++ b/README.md @@ -1,436 +1,2938 @@ -Policies can either be specified using the Group Policy templates 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/Content/Resources/distribution. +**These policies are in active development and so might contain changes that do not work with current versions of Firefox.** -The content of the JSON file should look like this: +**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. + +| Policy Name | Description +| --- | --- | +| **[`AppUpdateURL`](#AppUpdateURL)** | Change the URL for application update. +| **[`Authentication`](#Authentication)** | Configure sites that support integrated authentication. +| **[`BlockAboutAddons`](#blockaboutaddons)** | Block access to the Add-ons Manager (about:addons). +| **[`BlockAboutConfig`](#blockaboutconfig)** | Block access to about:config. +| **[`BlockAboutProfiles`](#blockaboutprofiles)** | Block access to About Profiles (about:profiles). +| **[`BlockAboutSupport`](#blockaboutsupport)** | Block access to Troubleshooting Information (about:support). +| **[`Bookmarks`](#bookmarks)** | Add bookmarks in either the bookmarks toolbar or menu. +| **[`CaptivePortal`](#captiveportal)** | Enable or disable the detection of captive portals. +| **[`Certificates`](#certificates)** | +| **[`Certificates -> ImportEnterpriseRoots`](#certificates--importenterpriseroots)** | Trust certificates that have been added to the operating system certificate store by a user or administrator. +| **[`Certificates -> Install`](#certificates--install)** | Install certificates into the Firefox certificate store. +| **[`Cookies`](#cookies)** | Configure cookie preferences. +| **[`DisableSetDesktopBackground`](#disablesetdesktopbackground)** | Remove the "Set As Desktop Background..." menuitem when right clicking on an image. +| **[`DisableMasterPasswordCreation`](#disablemasterpasswordcreation)** | Remove the master password functionality. +| **[`DisableAppUpdate`](#disableappupdate)** | Turn off application updates. +| **[`DisableBuiltinPDFViewer`](#disablebuiltinpdfviewer)** | Disable the built in PDF viewer. +| **[`DisableDeveloperTools`](#disabledevelopertools)** | Remove access to all developer tools. +| **[`DisableFeedbackCommands`](#disablefeedbackcommands)** | Disable the menus for reporting sites. +| **[`DisableFirefoxScreenshots`](#disablefirefoxscreenshots)** | Remove access to Firefox Screenshots. +| **[`DisableFirefoxAccounts`](#disablefirefoxaccounts)** | Disable Firefox Accounts integration (Sync). +| **[`DisableFirefoxStudies`](#disablefirefoxstudies)** | Disable Firefox studies (Shield). +| **[`DisableForgetButton`](#disableforgetbutton)** | Disable the "Forget" button. +| **[`DisableFormHistory`](#disableformhistory)** | Turn off saving information on web forms and the search bar. +| **[`DisablePocket`](#disablepocket)** | Remove Pocket in the Firefox UI. +| **[`DisablePrivateBrowsing`](#disableprivatebrowsing)** | Remove access to private browsing. +| **[`DisableProfileImport`](#disableprofileimport)** | Disables the "Import data from another browser" option in the bookmarks window. +| **[`DisableProfileRefresh`](#disableprofilerefresh)** | Disable the Refresh Firefox button on about:support and support.mozilla.org +| **[`DisableSafeMode`](#disablesafemode)** | Disable safe mode within the browser. +| **[`DisableSecurityBypass`](#disablesecuritybypass)** | Prevent the user from bypassing security in certain cases. +| **[`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. +| **[`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. +| **[`OfferToSaveLogins`](#offertosavelogins)** | Control whether or not Firefox offers to save passwords. +| **[`OfferToSaveLoginsDefault`](#offertosaveloginsdefault)** | Set the default value for whether or not Firefox offers to save passwords. +| **[`OverrideFirstRunPage`](#overridefirstrunpage)** | Override the first run page. +| **[`OverridePostUpdatePage`](#overridepostupdatepage)** | Override the upgrade page. +| **[`PasswordManagerEnabled`](#passwordmanagerenabled)** | Remove (some) access to the password manager. +| **[`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` (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. +| **[`SearchEngines -> PreventInstalls`](#searchengines--preventinstalls)** | Prevent installing search engines from webpages. +| **[`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. + +**Compatibility:** Firefox 62, Firefox ESR 60.2\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `app.update.url` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\AppUpdateURL = "https://yoursite.com" +``` +#### macOS +``` + + AppUpdateURL + https://yoursite.com + +``` +#### policies.json ``` { "policies": { - ...POLICIES... + "AppUpdateURL": "https://yoursite.com" } } ``` -Policies are documented below. Note that even though comments are used in this file for documentation, comments are not allowed for JSON files. ### Authentication -This policy is for configuring sites that support integrated authentication. See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information. + +Configure sites that support integrated authentication. + +See https://developer.mozilla.org/en-US/docs/Mozilla/Integrated_authentication for more information. + +**Compatibility:** Firefox 60, Firefox ESR 60 (AllowNonFQDN added in 62/60.2, AllowProxies added in 70/68.2)\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `network.negotiate-auth.trusted-uris`,`network.negotiate-auth.delegation-uris`,`network.automatic-ntlm-auth.trusted-uris`,`network.automatic-ntlm-auth.allow-non-fqdn`,`network.negotiate-auth.allow-non-fqdn`,`network.automatic-ntlm-auth.allow-proxies`,`network.negotiate-auth.allow-proxies` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Authentication\SPNEGO\1 = "mydomain.com" +Software\Policies\Mozilla\Firefox\Authentication\SPNEGO\2 = "https://myotherdomain.com" +Software\Policies\Mozilla\Firefox\Authentication\Delegated\1 = "mydomain.com" +Software\Policies\Mozilla\Firefox\Authentication\Delegated\2 = "https://myotherdomain.com" +Software\Policies\Mozilla\Firefox\Authentication\NTLM\1 = "mydomain.com" +Software\Policies\Mozilla\Firefox\Authentication\NTLM\2 = "https://myotherdomain.com" +Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\SPNEGO = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Authentication\AllowNonFQDN\NTLM = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Authentication\AllowProxies\SPNEGO = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Authentication\AllowProxies\NTLM = 0x1 | 0x0 +``` +#### macOS +``` + + Authentication + + SPNEGO + + mydomain.com + https://myotherdomain.com + + Delegated + + mydomain.com + https://myotherdomain.com + + NTLM + + mydomain.com + https://myotherdomain.com + + AllowNonFQDN + + SPNEGO + | + NTLM + | + + AllowProxies + + SPNEGO + | + NTLM + | + + + +``` +#### policies.json ``` { "policies": { "Authentication": { "SPNEGO": ["mydomain.com", "https://myotherdomain.com"], "Delegated": ["mydomain.com", "https://myotherdomain.com"], - "NTLM": ["mydomain.com", "https://myotherdomain.com"] + "NTLM": ["mydomain.com", "https://myotherdomain.com"], + "AllowNonFQDN": { + "SPNEGO": true | false, + "NTLM": true | false + }, + "AllowProxies": { + "SPNEGO": true | false, + "NTLM": true | false + } } } } ``` ### BlockAboutAddons -This policy removes access to about:addons. + +Block access to the Add-ons Manager (about:addons). + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableAddonsManager`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\BlockAboutAddons = 0x1 | 0x0 +``` +#### macOS +``` + + BlockAboutAddons + | + +``` +#### policies.json ``` { "policies": { - "BlockAboutAddons": true + "BlockAboutAddons": true | false } } ``` ### BlockAboutConfig -This policy removes access to about:config. + +Block access to about:config. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableAboutConfig`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\BlockAboutConfig = 0x1 | 0x0 +``` +#### macOS +``` + + BlockAboutConfig + | + +``` +#### policies.json ``` { "policies": { - "BlockAboutConfig": true + "BlockAboutConfig": true | false } } ``` ### BlockAboutProfiles -This policy removes access to about:profiles. + +Block access to About Profiles (about:profiles). + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableAboutProfiles`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\BlockAboutProfiles = 0x1 | 0x0 +``` +#### macOS +``` + + BlockAboutProfiles + | + +``` +#### policies.json ``` { "policies": { - "BlockAboutProfiles": true + "BlockAboutProfiles": true | false } } ``` ### BlockAboutSupport -This policy removes access to about:support. + +Block access to Troubleshooting Information (about:support). + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableAboutSupport`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\BlockAboutSupport = 0x1 | 0x0 +``` +#### macOS +``` + + BlockAboutSupport + | + +``` +#### policies.json +``` +{ + "policies": { + "BlockAboutSupport": true | false + } +} +``` +### Bookmarks + +Add bookmarks in either the bookmarks toolbar or menu. Only `Title` and `URL` are required. If `Placement` is not specified, the bookmark will be placed on the toolbar. If `Folder` is specified, it is automatically created and bookmarks with the same folder name are grouped together. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `bookmarks.toolbar`,`bookmarks.menu`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Bookmarks\1\Title = "Example" +Software\Policies\Mozilla\Firefox\Bookmarks\1\URL = "https://example.com" +Software\Policies\Mozilla\Firefox\Bookmarks\1\Favicon = "https://example.com/favicon.ico" +Software\Policies\Mozilla\Firefox\Bookmarks\1\Placement = "toolbar" | "menu" +Software\Policies\Mozilla\Firefox\Bookmarks\1\Folder = "FolderName" +``` +#### macOS +``` + + Bookmarks + + + Title + Example + URL + https://example.com + Favicon + https://example.com/favicon.ico + Placement + toolbar | menu + Folder + FolderName + + + +``` +#### policies.json ``` { "policies": { - "BlockAboutSupport": true + "Bookmarks": [ + { + "Title": "Example", + "URL": "https://example.com", + "Favicon": "https://example.com/favicon.ico", + "Placement": "toolbar" | "menu", + "Folder": "FolderName" + } + ] + } } ``` -### BlockSetDesktopBackground -This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image. +### CaptivePortal +Enable or disable the detection of captive portals. + +**Compatibility:** Firefox 67, Firefox ESR 60.7\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `network.captive-portal-service.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\CaptivePortal = 0x1 | 0x0 +``` +#### macOS +``` + + CaptivePortal + | + +``` +#### policies.json ``` { "policies": { - "BlockAboutSupport": true + "CaptivePortal": true | false } } ``` ### Certificates -This is a Windows only policy that tells Firefox to read certificates from the Windows certificate store. + +### Certificates | ImportEnterpriseRoots + +Trust certificates that have been added to the operating system certificate store by a user or administrator. + +See https://support.mozilla.org/kb/setting-certificate-authorities-firefox for more detail. + +**Compatibility:** Firefox 60, Firefox ESR 60 (macOS support in Firefox 63, Firefox ESR 68)\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `security.enterprise_roots.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Certificates\ImportEnterpriseRoots = 0x1 | 0x0 +``` +#### macOS +``` + + Certificates + + ImportEnterpriseRoots + | + + +``` +#### policies.json +``` +{ + "policies": { + "Certificates": { + "ImportEnterpriseRoots": true | false + } + } +} +``` +### Certificates | Install + +Install certificates into the Firefox certificate store. If only a filename is specified, Firefox searches for the file in the following locations: + +- Windows + - %USERPROFILE%\AppData\Local\Mozilla\Certificates + - %USERPROFILE%\AppData\Roaming\Mozilla\Certificates +- macOS + - /Library/Application Support/Mozilla/Certificates + - ~/Library/Application Support/Mozilla/Certificates +- Linux + - /usr/lib/mozilla/certificates + - /usr/lib64/mozilla/certificates + - ~/.mozilla/certificates + +Starting with Firefox 65, Firefox 60.5 ESR, a fully qualified path can be used, including UNC paths. You should use the native path style for your operating system. We do not support using %USERPROFILE% or other environment variables on Windows. + +If you are specifying the path in the policies.json file on Windows, you need to escape your backslashes (`\\`) which means that for UNC paths, you need to escape both (`\\\\`). If you use group policy, you only need one backslash. + +Certificates are installed using the trust string `CT,CT,`. + +Binary (DER) and ASCII (PEM) certificates are both supported. + +**Compatibility:** Firefox 64, Firefox ESR 64\ +**CCK2 Equivalent:** `certs.ca`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Certificates\Install\1 = "cert1.der" +Software\Policies\Mozilla\Firefox\Certificates\Install\2 = "C:\Users\username\cert2.pem" +``` +#### macOS +``` + + Certificates + + Install + + cert1.der + /Users/username/cert2.pem + + + +``` +#### policies.json ``` { "policies": { "Certificates": { - "ImportEnterpriseRoots": [true|false] + "Install": ["cert1.der", "/home/username/cert2.pem"] } } } ``` ### Cookies -This policy controls various settings related to cookies. +Configure cookie preferences. + +`Allow` is a list of origins (not domains) where cookies are always allowed. You must include http or https. + +`Block` is a list of origins (not domains) where cookies are always blocked. You must include http or https. + +`Default` determines whether cookies are accepted at all. + +`AcceptThirdParty` determines how third-party cookies are handled. + +`ExpireAtSessionEnd` determines when cookies expire. + +`RejectTracker` only rejects cookies for trackers. + +`Locked` prevents the user from changing cookie preferences. + +**Compatibility:** Firefox 60, Firefox ESR 60 (RejectTracker was added in Firefox 63)\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `network.cookie.cookieBehavior`,`network.cookie.lifetimePolicy` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Cookies\Allow\1 = "https://example.com" +Software\Policies\Mozilla\Firefox\Cookies\Block\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\Cookies\Default = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Cookies\AcceptThirdParty = "always" | "never" |"from-visited" +Software\Policies\Mozilla\Firefox\Cookies\ExpireAtSessionEnd = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Cookies\RejectTracker = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Cookies\Locked = 0x1 | 0x0 +``` +#### macOS +``` + + Cookies + + Allow + + http://example.com + + Block + + http://example.org + + Default + | + AcceptThirdParty + always | never | from-visited + ExpireAtSessionEnd + | + RejectTracker + | + Locked + | + + +``` +#### policies.json ``` { "policies": { "Cookies": { - "Allow": ["http://example.org/"], /* Domains where cookies are always allowed */ - "Block": ["http://example.edu/"], /* Domains where cookies are always blocked */ - "Default": [true|false], /* This sets the default value for "Accept cookies from websites" */ - "AcceptThirdParty": ["all", "none", "from-visited"], /* This sets the default value for "Accept third-party cookies" */ - "ExpireAtSessionEnd": [true|false], /* This determines when cookies expire */ - "Locked": [true|false] /* If this is true, cookies preferences can't be changed */ + "Allow": ["http://example.org/"], + "Block": ["http://example.edu/"], + "Default": true | false, + "AcceptThirdParty": "always" | "never" | "from-visited"], + "ExpireAtSessionEnd": true | false, + "RejectTracker": true | false, + "Locked": true | false } } } ``` -### CreateMasterPassword -This policy removes the master password functionality. +### DisableSetDesktopBackground +Remove the "Set As Desktop Background..." menuitem when right clicking on an image. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `removeSetDesktopBackground`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableSetDesktopBackground = 0x1 | 0x0 +``` + +#### macOS +``` + + DisableSetDesktopBackground + | + +``` +#### policies.json +``` +{ + "policies": { + "DisableSetDesktopBackground": true | false + } +} +``` +### DisableMasterPasswordCreation +Remove the master password functionality. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `noMasterPassword`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableMasterPasswordCreation = 0x1 | 0x0 +``` + +#### macOS +``` + + DisableMasterPasswordCreation + | + +``` +#### policies.json ``` { "policies": { - "CreateMasterPassword": false + "DisableMasterPasswordCreation": true | false } } ``` ### DisableAppUpdate -This policy turns off application updates. +Turn off application updates. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableFirefoxUpdates`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableAppUpdate = 0x1 | 0x0 +``` +#### macOS +``` + + DisableAppUpdate + | + +``` +#### policies.json ``` { "policies": { - "DisableAppUpdate": true + "DisableAppUpdate": true | false } } ``` ### DisableBuiltinPDFViewer -This policy disables the built in PDF viewer. PDF files are downloaded and sent externally. +Disable 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 (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableBuiltinPDFViewer = 0x1 | 0x0 +``` + +#### macOS +``` + + DisableBuiltinPDFViewer + | + +``` +#### policies.json ``` { "policies": { - "DisableBuiltinPDFViewer": true + "DisableBuiltinPDFViewer": true | false } } ``` ### DisableDeveloperTools -This policy removes access to all developer tools. +Remove access to all developer tools. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `removeDeveloperTools`\ +**Preferences Affected:** `devtools.policy.disabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableDeveloperTools = 0x1 | 0x0` +``` + +#### macOS +``` + + DisableDeveloperTools + | + +``` +#### policies.json ``` { "policies": { - "DisableDeveloperTools": true + "DisableDeveloperTools": true | false } } ``` ### DisableFeedbackCommands -This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site) +Disable 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 (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableFeedbackCommands = 0x1 | 0x0 +``` +#### macOS +``` + + DisableFeedbackCommands + | + +``` +#### policies.json ``` { "policies": { - "DisableFeedbackCommands": true + "DisableFeedbackCommands": true | false } } ``` ### DisableFirefoxScreenshots -This policy removes access to Firefox Screenshots +Remove access to Firefox Screenshots. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `extensions.screenshots.disabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableFirefoxScreenshots = 0x1 | 0x0 +``` +#### macOS +``` + + DisableFirefoxScreenshots + | + +``` +#### policies.json ``` { "policies": { - "DisableFirefoxScreenshots": true + "DisableFirefoxScreenshots": true | false } } ``` ### DisableFirefoxAccounts -This policy disables Sync +Disable Firefox Accounts integration (Sync). + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableSync`\ +**Preferences Affected:** `identity.fxaccounts.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableFirefoxAccounts = 0x1 | 0x0 +``` +#### macOS +``` + + DisableFirefoxAccounts + | + +``` +#### policies.json ``` { "policies": { - "DisableFirefoxAccounts": true + "DisableFirefoxAccounts": true | false } } ``` ### DisableFirefoxStudies -This policy disables Firefox studies (Shield) +Disable Firefox studies (Shield). + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableForget`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableFirefoxStudies = 0x1 | 0x0 +``` +#### macOS +``` + + DisableFirefoxStudies + | + +``` +#### policies.json ``` { "policies": { - "DisableFirefoxAccounts": true + "DisableFirefoxStudies": true | false } } ``` ### DisableForgetButton -This policy disables the "Forget" button +Disable the "Forget" button. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disableForget`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableForgetButton = 0x1 | 0x0 +``` +#### macOS +``` + + DisableForgetButton + | + +``` +#### policies.json ``` { "policies": { - "DisableForgetButton": true + "DisableForgetButton": true | false } } ``` ### DisableFormHistory -This policy turns off the browser.formfill.enable preferences +Turn 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 (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableFormHistory = 0x1 | 0x0 +``` +#### macOS +``` + + DisableFormHistory + | + +``` +#### policies.json ``` { "policies": { - "DisableFormHistory": true + "DisableFormHistory": true | false } } ``` ### DisablePocket -This policy turns off Pocket +Remove 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 (GPO) +``` +Software\Policies\Mozilla\Firefox\DisablePocket = 0x1 | 0x0 +``` +#### macOS +``` + + DisablePocket + | + +``` +#### policies.json ``` { "policies": { - "DisablePocket": true + "DisablePocket": true | false } } ``` ### DisablePrivateBrowsing -This policy removes access to private browsing +Remove access to private browsing. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `disablePrivateBrowsing`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisablePrivateBrowsing = 0x1 | 0x0 +``` +#### macOS +``` + + DisablePrivateBrowsing + | + +``` +#### policies.json +``` +{ + "policies": { + "DisablePrivateBrowsing": true | false + } +} +``` +### DisableProfileImport +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 (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableProfileImport = 0x1 | 0x0 +``` +#### macOS +``` + + DisableProfileImport + | + +``` +#### policies.json ``` { "policies": { - "DisablePrivateBrowsing": true + "DisableProfileImport": true | false } } ``` ### DisableProfileRefresh -This policy disables the Refresh Firefox button on about:support and support.mozilla.org. +Disable 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 (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableProfileRefresh = 0x1 | 0x0 +``` +#### macOS +``` + + DisableProfileRefresh + | + +``` +#### policies.json ``` { "policies": { - "DisableProfileRefresh": true + "DisableProfileRefresh": true | false } } ``` ### DisableSafeMode -This policy disables safe mode on Windows only +Disable safe mode within the browser. + +On Windows, this disables safe mode via the command line as well. + +**Compatibility:** Firefox 60, Firefox ESR 60 (Windows, macOS)\ +**CCK2 Equivalent:** `disableSafeMode`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableSafeMode = 0x1 | 0x0 +``` +#### macOS +``` + + DisableSafeMode + | + +``` +#### policies.json ``` { "policies": { - "DisableSafeMode": true + "DisableSafeMode": true | false } } ``` ### DisableSecurityBypass -This policy prevents the user from bypassign security in certain cases. +Prevent the user from bypassing security in certain cases. + +`InvalidCertificate` prevents adding an exception when an invalid certificate is shown. + +`SafeBrowsing` prevents selecting "ignore the risk" and visiting a harmful site anyway. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `security.certerror.hideAddException`,`browser.safebrowsing.allowOverride` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableSecurityBypass\InvalidCertificate = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\DisableSecurityBypass\SafeBrowsing = 0x1 | 0x0 +``` +#### macOS +``` + + DisableSecurityBypass + + InvalidCertificate + | + + | + + +``` +#### policies.json ``` { "policies": { "DisableSecurityBypass": { - "InvalidCertificate": [true|false], /* Prevents adding an exception when an invalid certificate is shown */ - "SafeBrowsing": [true|false] /* Prevents selecting "ignore the risk" and visiting a harmful site anyway */ + "InvalidCertificate": true false, + "SafeBrowsing": true false } } } ``` -### DisableSysAddonUpdate -This policy prevents system add-ons from being updated or installed. +### DisableSystemAddonUpdate +Prevent system add-ons from being installed or update. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows (GPO) +```Software\Policies\Mozilla\Firefox\DisableSystemAddonUpdate = 0x1 | 0x0 +``` +#### macOS +``` + + DisableSystemAddonUpdate + | + +``` +#### policies.json ``` { "policies": { - "DisableSysAddonUpdate": true + "DisableSystemAddonUpdate": true | false } } ``` ### DisableTelemetry -This policy prevents the upload of telemetry data. Mozilla strongly recommends that you do NOT disable telemetry if you do not have a business need to do so. +Prevent 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 (GPO) +``` +Software\Policies\Mozilla\Firefox\DisableTelemetry = 0x1 | 0x0 +``` +#### macOS +``` + + DisableTelemetry + | + +``` +#### policies.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. +Set the initial state of the bookmarks toolbar. A user can still hide it and it will stay hidden. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `displayBookmarksToolbar`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DisplayBookmarksToolbar = 0x1 | 0x0 +``` +#### macOS +``` + + DisplayBookmarksToolbar + | + +``` +#### policies.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. +Set the initial state of the menubar. A user can still hide it and it will stay hidden. + +**Compatibility:** Firefox 60, Firefox ESR 60 (Windows, some Linux)\ +**CCK2 Equivalent:** `displayMenuBar`\ +**Preferences Affected:** N/A + +#### Windows (GPO) ``` -{ - "policies": { - "DisplayMenuBar": true - } -} +Software\Policies\Mozilla\Firefox\DisplayMenuBar = 0x1 | 0x0 ``` -### DontCheckDefaultBrowser -This policy stops Firefox from checking if it is the default browser at startup. +#### macOS +``` + + DisplayMenuBar + | + +``` +#### policies.json ``` { "policies": { - "DontCheckDefaultBrowser": true + "DisplayMenuBar": true | false } } ``` -### EnableTrackingProtection -This policy affects tracking protection. +### DNSOverHTTPS +Configure DNS over HTTPS. + +`Enabled` determines whether DNS over HTTPS is enabled -If this policy is not configured, tracking protection is not enabled by default in the browser but it is enabled by default in private browsing and the user can change it. +`ProviderURL` is a URL to another provider. -If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing. +`Locked` prevents the user from changing DNS over HTTPS preferences. -If Value is set to true, private browsing is enabled by default in both the browser and private browsing and you can choose set the Locked value if you want to prevent the user from changing it. +**Compatibility:** Firefox 63, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `network.trr.mode`,`network.trr.uri` + +#### Windows (GPO) +``` +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 +``` + + DNSOverHTTPS + + Enabled + | + ProviderURL + URL_TO_ALTERNATE_PROVIDER + Locked + | + + +``` +#### policies.json ``` { "policies": { - "EnableTrackingProtection": { + "DNSOverHTTPS": { + "Enabled": true | false, + "ProviderURL": "URL_TO_ALTERNATE_PROVIDER", + "Locked": true | false + } + } +} +``` +### DontCheckDefaultBrowser +Don't check if Firefox is the default browser at startup. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `dontCheckDefaultBrowser`\ +**Preferences Affected:** `browser.shell.checkDefaultBrowser` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\DontCheckDefaultBrowser = 0x1 | 0x0 +``` +#### macOS +``` + + DontCheckDefaultBrowser + | + +``` +#### policies.json +``` +{ + "policies": { + "DontCheckDefaultBrowser": true | false + } +} +``` +### 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 (GPO) +``` +Software\Policies\Mozilla\Firefox\DefaultDownloadDirectory = "${home}\Downloads" +``` +#### macOS +``` + + DefaultDownloadDirectory + ${home}/Downloads + +``` +#### policies.json (macOS and Linux) +``` +{ + "policies": { + "DefaultDownloadDirectory": "${home}/Downloads" +} +``` +#### policies.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 (GPO) +``` +Software\Policies\Mozilla\Firefox\DownloadDirectory = "${home}\Downloads" +``` +#### macOS +``` + + DownloadDirectory + ${home}/Downloads + +``` +#### policies.json (macOS and Linux) +``` +{ + "policies": { + "DownloadDirectory": "${home}/Downloads" +} +``` +#### policies.json (Windows) +``` +{ + "policies": { + "DownloadDirectory": "${home}\\Downloads" +} +``` +### EnableTrackingProtection +Configure tracking protection. + +If this policy is not configured, tracking protection is not enabled by default in the browser, but it is enabled by default in private browsing and the user can change it. + +If `Value` is set to false, tracking protection is disabled and locked in both the regular browser and private browsing. + +If `Value` is set to true, tracking protection is enabled by default in both the regular browser and private browsing and the `Locked` value determines whether or not a user can change it. + +If `Cryptomining` is set to true, cryptomining scripts on websites are blocked. + +If `Fingerprinting` is set to true, fingerprinting scripts on websites are blocked. + +**Compatibility:** Firefox 60, Firefox ESR 60 (Cryptomining and Fingerprinting added in 70/68.2)\ +**CCK2 Equivalent:** `dontCheckDefaultBrowser`\ +**Preferences Affected:** `privacy.trackingprotection.enabled`,`privacy.trackingprotection.pbmode.enabled`,`privacy.trackingprotection.cryptomining.enabled`,`privacy.trackingprotection.fingerprinting.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Value = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Cryptomining = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\EnableTrackingProtection\Fingerprinting = 0x1 | 0x0 +``` +#### macOS +``` + + EnableTrackingProtection + + Value + | + + | + + | + + | + + +``` +#### policies.json +``` +{ + "policies": { + "EnableTrackingProtection": { "Value": [true, false], - "Locked": [true, false] + "Locked": [true, false], + "Cryptomining": [true, false], + "Fingerprinting": [true, false] } +} +``` +### 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 -This policy controls the install, uninstall and locking of extensions. Locked extensions cannot be disabled or uninstalled. -For Install, you can specify a list of URLs or paths. -For Uninstall and Locked, you specify extension IDs. +Control the installation, uninstallation and locking of extensions. + +`Install` is a list of URLs or native paths for extensions to be installed. + +`Uninstall` is a list of extension IDs that should be uninstalled if found. + +`Locked` is a list of extension IDs that the user cannot disable or uninstall. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `addons`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Extensions\Install\1 = "https://addons.mozilla.org/firefox/downloads/somefile.xpi" +Software\Policies\Mozilla\Firefox\Extensions\Install\2 = "//path/to/xpi" +Software\Policies\Mozilla\Firefox\Extensions\Uninstall\1 = "bad_addon_id@mozilla.org" +Software\Policies\Mozilla\Firefox\Extensions\Locked\1 = "addon_id@mozilla.org" +``` +#### macOS +``` + + Extensions + + Install + + https://addons.mozilla.org/firefox/downloads/somefile.xpi + //path/to/xpi + + Uninstall + + bad_addon_id@mozilla.org + + Locked + + addon_id@mozilla.org + + + +``` +#### policies.json ``` { "policies": { "Extensions": { - "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"] - "Uninstall": ["addon_id@mozilla.org"], + "Install": ["https://addons.mozilla.org/firefox/downloads/somefile.xpi", "//path/to/xpi"], + "Uninstall": ["bad_addon_id@mozilla.org"], "Locked": ["addon_id@mozilla.org"] } + } +} ``` -### NoDefaultBookmarks -Don't create the default bookmarks or the Smart Bookmarks (Most Visited, Recent Tags). Note: this policy is only effective if used before the first run of the profile. +### 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 from the local file system, use a file:/// URL. Languages packs are available from https://releases.mozilla.org/pub/firefox/releases/VERSION/PLATFORM/xpi/LANGUAGE.xpi. +| `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 (GPO) +``` +Software\Policies\Mozilla\Firefox\ExtensionSettings (REG_MULTI_SZ) = +{ + "*": { + "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" + } +} +``` +#### 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 + + + +``` +#### policies.json ``` { "policies": { - "NoDefaultBookmarks": true + "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" + } + } } } ``` -### RememberPasswords -This policy sets the signon.rememberSignons preference. It can either be enabled or disabled. +### ExtensionUpdate +Control extension updates. + +**Compatibility:** Firefox 67, Firefox ESR 60.7\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `extensions.update.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\ExtensionUpdate = 0x1 | 0x0 +``` +#### macOS +``` + + ExtensionUpdate + | + +``` +#### policies.json +``` +{ + "policies": { + "ExtensionUpdate": true | false + } +} +``` +### FlashPlugin +Configure the default Flash plugin policy as well as origins for which Flash is allowed. + +`Allow` is a list of origins where Flash are allowed. + +`Block` is a list of origins where Flash is not allowed. + +`Default` determines whether or not Flash is allowed by default. + +`Locked` prevents the user from changing Flash preferences. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `permissions.plugin`\ +**Preferences Affected:** `plugin.state.flash` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\FlashPlugin\Allow\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\FlashPlugin\Block\1 = "https://example.edu" +Software\Policies\Mozilla\Firefox\FlashPlugin\Default = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\FlashPlugin\Locked = 0x1 | 0x0 +``` +#### macOS +``` + + FlashPlugin + + Allow + + http://example.org + + Block + + http://example.edu + + Default + | + Locked + | + + +``` +#### policies.json +``` +{ + "policies": { + "FlashPlugin": { + "Allow": ["http://example.org/"], + "Block": ["http://example.edu/"], + "Default": true | false, + "Locked": true | false + } + } +} +``` +### 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 (GPO) +``` +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 + | + + +``` +#### policies.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. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `layers.acceleration.disabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\HardwareAcceleration = 0x1 | 0x0 +``` +#### macOS +``` + + HardwareAcceleration + | + +``` +#### policies.json ``` { "policies": { - "RememberPasswords": true + "HardwareAcceleration": true | false } } ``` ### Homepage -This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages. +Configure the default homepage and how Firefox starts. + +`URL` is the default homepage. + +`Locked` prevents the user from changing homepage preferences. + +`Additional` allows for more than one homepage. + +`StartPage` is how Firefox starts. The choices are no homepage, the default homepage or the previous session. + +**Compatibility:** Firefox 60, Firefox ESR 60 (StartPage was added in Firefox 60, Firefox ESR 60.4)\ +**CCK2 Equivalent:** `homePage`,`lockHomePage`\ +**Preferences Affected:** `browser.startup.homepage`,`browser.startup.page` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Homepage\URL = "https://example.com" +Software\Policies\Mozilla\Firefox\Homepage\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Homepage\Additional\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\Homepage\Additional\2 = "https://example.edu" +Software\Policies\Mozilla\Firefox\Homepage\StartPage = "none" | "homepage" | "previous-session" +``` +#### macOS +``` + + Homepage + + URL + http://example.com + Locked + | + Additional + + http://example.org + http://example.edu + + StartPage + none | homepage | previous-session + + +``` +#### policies.json ``` { "policies": { "Homepage": { "URL": "http://example.com/", - "Locked": true, + "Locked": true | false, "Additional": ["http://example.org/", - "http://example.edu/"] + "http://example.edu/"], + "StartPage": "none" | "homepage" | "previous-session" } } } ``` -### Popups -This policy sets domains for which popups are allowed +### InstallAddonsPermission +Configure the default extension install policy as well as origins for extension installs are allowed. This policy does not override turning off all extension installs. + +`Allow` is a list of origins where extension installs are allowed. + +`Default` determines whether or not extension installs are allowed by default. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `permissions.install`\ +**Preferences Affected:** `xpinstall.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Allow\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Allow\2 = "https://example.edu" +Software\Policies\Mozilla\Firefox\InstallAddonsPermission\Default = 0x1 | 0x0 +``` +#### macOS +``` + + InstallAddonsPermission + + Allow + + http://example.org + http://example.edu + + Default + | + + +``` +#### policies.json ``` { "policies": { - "Popups": { + "InstallAddonsPermission": { "Allow": ["http://example.org/", - "http://example.edu/"] + "http://example.edu/"], + "Default": true | false } } } ``` -### InstallAddons -This policy sets domains that can install extensions, as well as the default behavior. +### 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 (GPO) +``` +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 (GPO) +``` +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 + + +``` +#### policies.json ``` { "policies": { - "InstallAddons": { - "Allow": ["http://example.org/", - "http://example.edu/"] - "Default": [true|false], /* If this is set to false, add-ons cannot be installed by the user */ - } + "LocalFileLinks": ["http://example.org/", + "http://example.edu/"] } } ``` -### FlashPlugin -This policy sets the behavior of Flash on the specified domains, as well as the default behavior. +### NoDefaultBookmarks +Disable the creation of default bookmarks. + +This policy is only effective if the user profile has not been created yet. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `removeDefaultBookmarks`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\NoDefaultBookmarks = 0x1 | 0x0 +``` +#### macOS +``` + + NoDefaultBookmarks + | + +``` +#### policies.json ``` { "policies": { - "FlashPlugin": { - "Allow": ["http://example.org/"], /* Sites on the allow list do not override Flash being completely disabled */ - "Block": ["http://example.edu/"], - "Default": [true|false], /* If this is set to true, flash is always enabled. If it is set to false, Flash is never enabled */ - "Locked": [true|false] - } + "NoDefaultBookmarks": true | false + } +} +``` +### NetworkPrediction +Enable or disable network prediction (DNS prefetching). + +**Compatibility:** Firefox 67, Firefox ESR 60.7\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `network.dns.disablePrefetch`,`network.dns.disablePrefetchFromHTTPS` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\NetworkPrediction = 0x1 | 0x0 +``` +#### macOS +``` + + NetworkPrediction + | + +``` +#### policies.json +``` +{ + "policies": { + "NetworkPrediction": true | false +} +``` +### NewTabPage +Enable or disable the New Tab page. + +**Compatibility:** Firefox 68, Firefox ESR 68\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `browser.newtabpage.enabled` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\NewTabPage = 0x1 | 0x0 +``` +#### macOS +``` + + NewTabPage + | + +``` +#### policies.json +``` +{ + "policies": { + "NewTabPage": true | false +} +``` +### OfferToSaveLogins +Control whether or not Firefox offers to save passwords. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `dontRememberPasswords`\ +**Preferences Affected:** `signon.rememberSignons` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\OfferToSaveLogins = 0x1 | 0x0 +``` +#### macOS +``` + + OfferToSaveLogins + | + +``` +#### policies.json +``` +{ + "policies": { + "OfferToSaveLogins": true | false + } +} +``` +### OfferToSaveLoginsDefault +Sets the default value of signon.rememberSignons without locking it. + +**Compatibility:** Firefox 70, Firefox ESR 60.2\ +**CCK2 Equivalent:** `dontRememberPasswords`\ +**Preferences Affected:** `signon.rememberSignons` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\OfferToSaveLoginsDefault = 0x1 | 0x0 +``` +#### macOS +``` + + OfferToSaveLoginsDefault + | + +``` +#### policies.json +``` +{ + "policies": { + "OfferToSaveLoginsDefault": true | false } } ``` ### OverrideFirstRunPage -This policy allowed you to override the first run page. If you leave the URL blank, the first run page will not be displayed. +Override the first run page. If the value is blank, no first run page is displayed. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `welcomePage`,`noWelcomePage`\ +**Preferences Affected:** `startup.homepage_welcome_url` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\OverrideFirstRunPage = "http://example.org" +``` +#### macOS +``` + + OverrideFirstRunPage + http://example.org + +``` +#### policies.json ``` { "policies": { "OverrideFirstRunPage": "http://example.org" - } } ``` ### OverridePostUpdatePage -This policy allowed you to override the upgrade page page. If you leave the URL blank, the upgrade page will not be displayed. +Override the upgrade page. If the value is blank, no upgrade page is displayed. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `upgradePage`,`noUpgradePage`\ +**Preferences Affected:** `startup.homepage_override_url` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\OverridePostUpdatePage = "http://example.org" +``` +#### macOS +``` + + OverridePostUpdatePage + http://example.org + +``` +#### policies.json ``` { "policies": { "OverridePostUpdatePage": "http://example.org" +} +``` +### PasswordManagerEnabled +Remove access to the password manager via preferences and blocks about:logins on Firefox 70. + +**Compatibility:** Firefox 70, Firefox ESR 60.2\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `prefs.privacy.disable_button.view_passwords` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\PasswordManagerEnabled = 0x1 | 0x0 +``` +#### macOS +``` + + PasswordManagerEnabled + | + +``` +#### policies.json +``` +{ + "policies": { + "PasswordManagerEnabled": true | false } } ``` -### Bookmarks -This policy allows you to specify bookmarks. You can have any number of bookmarks although only ten are specified in the ADMX file. -Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the -same folder name are grouped together. +### Permissions +Set permissions associated with camera, microphone, location, and notifications + +`Allow` is a list of origins where the feature is allowed. + +`Block` is a list of origins where the feature is not allowed. + +`BlockNewRequests` determines whether or not new requests can be made for the feature. + +`Locked` prevents the user from changing preferences for the feature. +**Compatibility:** Firefox 62, Firefox ESR 60.2\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `permissions.default.camera`,`permissions.default.microphone`,`permissions.default.geo`,`permissions.default.desktop-notification` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Permissions\Camera\Allow\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\Permissions\Camera\Block\1 = "https://example.edu" +Software\Policies\Mozilla\Firefox\Permissions\Camera\BlockNewRequests = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Permissions\Camera\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Permissions\Microphone\Allow\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\Permissions\Microphone\Block\1 = "https://example.edu" +Software\Policies\Mozilla\Firefox\Permissions\Microphone\BlockNewRequests = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Permissions\Microphone\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Permissions\Location\Allow\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\Permissions\Location\Block\1 = "https://example.edu" +Software\Policies\Mozilla\Firefox\Permissions\Location\BlockNewRequests = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Permissions\Location\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Permissions\Notifications\Allow\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\Permissions\Notifications\Block\1 = "https://example.edu" +Software\Policies\Mozilla\Firefox\Permissions\Notifications\BlockNewRequests = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Permissions\Notifications\Locked = 0x1 | 0x0 +``` +#### macOS +``` + + Permissions + + Camera + + Allow + + https://example.org + + Block + + https://example.edu + + BlockNewRequests + + Locked + + + Microphone + + Allow + + https://example.org + + Block + + https://example.edu + + BlockNewRequests + + Locked + + + Location + + Allow + + https://example.org + + Block + + https://example.edu + + BlockNewRequests + + Locked + + + Notifications + + Allow + + https://example.org + + Block + + https://example.edu + + BlockNewRequests + + Locked + + + + +``` +#### policies.json ``` { "policies": { - "Bookmarks": [ - {"Title": "Example", - "URL": "http://example.org", - "Favicon": "http://example.com/favicon.ico", - "Placement": ["toolbar", "menu"], - "Folder": "FolderName" - } - ] + "Permissions": { + "Camera": { + "Allow": ["https://example.org"], + "Block": ["https://example.edu"], + "BlockNewRequests": true | false, + "Locked": true | false + }, + "Microphone": { + "Allow": ["https://example.org"], + "Block": ["https://example.edu"], + "BlockNewRequests": true | false, + "Locked": true | false + }, + "Location": { + "Allow": ["https://example.org"], + "Block": ["https://example.edu"], + "BlockNewRequests": true | false, + "Locked": true | false + }, + "Notifications": { + "Allow": ["https://example.org"], + "Block": ["https://example.edu"], + "BlockNewRequests": true | false, + "Locked": true | false + } + } + } +} +``` +### PopupBlocking +Configure the default pop-up window policy as well as origins for which pop-up windows are allowed. + +`Allow` is a list of origins where popup-windows are allowed. + +`Default` determines whether or not pop-up windows are allowed by default. + +`Locked` prevents the user from changing pop-up preferences. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `permissions.popup`\ +**Preferences Affected:** `dom.disable_open_during_load` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\PopupBlocking\Allow\1 = "https://example.org" +Software\Policies\Mozilla\Firefox\PopupBlocking\Allow\2 = "https://example.edu" +Software\Policies\Mozilla\Firefox\PopupBlocking\Default = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\PopupBlocking\Locked = 0x1 | 0x0 +``` +#### macOS +``` + + PopupBlocking + + Allow + + http://example.org + http://example.edu + + Default + | + Locked + | + + +``` +#### policies.json +``` +{ + "policies": { + "PopupBlocking": { + "Allow": ["http://example.org/", + "http://example.edu/"], + "Default": true | false, + "Locked": true | false + } + } +} +``` +### Preferences +Set and lock certain preferences. + +**Compatibility:** See below\ +**CCK2 Equivalent:** `preferences`\ +**Preferences Affected:** See below + +| Preference | Type | Compatibility | Default +| --- | --- | --- | --- +| accessibility.force_disabled | integer | Firefox 70, Firefox ESR 68.2 | 0 +|     If set to 1, platform accessibility is disabled. +| app.update.auto | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, Firefox doesn't automatically install update. +| browser.bookmarks.autoExportHTML | boolean | Firefox 70, Firefox ESR 68.2 | false +|     If true, bookmarks are exported on shutdown. +| browser.bookmarks.file | string | Firefox 70, Firefox ESR 68.2 | N/A +|     If set, the name of the file where bookmarks are exported and imported. +| browser.bookmarks.restore_default_bookmarks | string | Firefox 70, Firefox ESR 68.2 | N/A +|     If true, bookmarks are restored to their defaults. +| browser.cache.disk.enable | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, don't store cache on the hard drive. +| browser.cache.disk.parent_directory | string | Firefox 68, Firefox ESR 68 | Profile temporary directory +|     If set, changes the location of the disk cache. +| browser.fixup.dns_first_for_single_words | boolean | Firefox 68, Firefox ESR 68 | false +|     If true, single words are sent to DNS, not directly to search. +| browser.places.importBookmarksHTML | string | Firefox 70, Firefox ESR 68.2 +|     If true, bookmarks are always imported on startup. +| browser.safebrowsing.phishing.enabled | string | Firefox 70, Firefox ESR 68.2 | true +|     If false, phishing protection is not enabled (Not recommended) +| browser.safebrowsing.malware.enabled | string | Firefox 70, Firefox ESR 68.2 | true +|     IF false, malware protection is not enabled (Not recommended) +| browser.search.update | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, updates for search engines are not checked. +| browser.slowStartup.notificationDisabled | string | Firefox 70, Firefox ESR 68.2 | false +|     If true, a notification isn't shown if startup is slow. +| browser.tabs.warnOnClose | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, there is no warning when the browser is closed. +| browser.taskbar.previews.enable | string | Firefox 70, Firefox ESR 68.2 (Windows only) | false +|     If true, tab previews are shown in the Windows taskbar. +| browser.urlbar.suggest.bookmark | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, bookmarks aren't suggested when typing in the URL bar. +| browser.urlbar.suggest.history | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, history isn't suggested when typing in the URL bar. +| browser.urlbar.suggest.openpage | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, open tabs aren't suggested when typing in the URL bar. +| datareporting.policy.dataSubmissionPolicyBypassNotification | boolean | Firefox 68, Firefox ESR 68 | false +|     If true, don't show the privacy policy tab on first run. +| dom.allow_scripts_to_close_windows | string | Firefox 70, Firefox ESR 68.2 | false +|     If false, web page can close windows. +| dom.disable_window_flip | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, web pages can focus and activate windows. +| dom.disable_window_move_resize | boolean | Firefox 68, Firefox ESR 68 | false +|     If true, web pages can't move or resize windows. +| dom.event.contextmenu.enabled | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, web pages can't override context menus. +| dom.keyboardevent.keypress.hack.dispatch_non_printable_keys.addl | string | Firefox 68, Firefox ESR 68 | 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 ESR 68 | N/A +|     See https://support.mozilla.org/en-US/kb/dom-events-changes-introduced-firefox-66 +| extensions.blocklist.enabled | string | Firefox 70, Firefox ESR 68.2 | true +|     If false, the extensions blocklist is not used (Not recommended) +| extensions.getAddons.showPane | boolean | Firefox 68, Firefox ESR 68 | N/A +|     If false, the Recommendations tab is not displayed in the Add-ons Manager. +| geo.enabled | string | Firefox 70, Firefox ESR 68.2 | true +|     If false, the geolocation API is disabled. | Language dependent +| intl.accept_languages | string | Firefox 70, Firefox ESR 68.2 +|     If set, preferred language for web pages. +| media.eme.enabled | string | Firefox 70, Firefox ESR 68.2 | true +|     If false, Encrypted Media Extensions are not enabled. +| media.gmp-gmpopenh264.enabled | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, the OpenH264 plugin is not downloaded. +| media.gmp-widevinecdm.enabled | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, the Widevine plugin is not downloaded. +| network.dns.disableIPv6 | boolean | Firefox 68, Firefox ESR 68 | false +|     If true, IPv6 DNS lokoups are disabled. +| network.IDN_show_punycode | boolean | Firefox 68, Firefox ESR 68 | false +|     If true, display the punycode version of internationalized domain names. +| places.history.enabled | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, history is not enabled. +| print.save_print_settings | string | Firefox 70, Firefox ESR 68.2 | true +|     If false, print settings are not saved between jobs. +| security.default_personal_cert | string | Firefox 68, Firefox ESR 68 | Ask Every Time +|     If set to Select Automatically, Firefox automatically chooses the default personal certificate. +| security.mixed_content.block_active_content | string | Firefox 70, Firefox ESR 68.2 | true +|     If false, mixed active content (HTTP and HTTPS) is not blocked. +| security.ssl.errorReporting.enabled | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, SSL errors cannot be sent to Mozilla. +| ui.key.menuAccessKeyFocuses | boolean | Firefox 68, Firefox ESR 68 | true +|     If false, the Alt key doesn't show the menubar on Windows. +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Preferences\boolean_preference_name = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Preferences\string_preference_name = "string_value" +``` +#### macOS +``` + + Preferences + + boolean_preference_name + | + string_preference_name + string_value + + +``` +#### policies.json +``` +{ + "policies": { + "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 (GPO) +``` +Software\Policies\Mozilla\Firefox\PromptForDownloadLocation = 0x1 | 0x0 +``` +#### macOS +``` + + PromptForDownloadLocation + | + +``` +#### policies.json +``` +{ + "policies": { + "PromptForDownloadLocation": true | false } } ``` ### Proxy -This policy allows you to specify proxy settings. These settings correspond to the connection settings in Firefox preferences. -To specify ports, append them to the hostnames with a colon (:). If Locked is set to true, the values can't be changed by the user. -``` -{ - "Proxy": { - "Mode": ["none", "system", "manual", "autoDetect", "autoConfig"] - "Locked": [true, false] - "HTTPProxy": "hostname", - "UseHTTPProxyForAllProtocols": [true, false] - "SSLProxy": "hostname", - "FTPProxy": "hostname", - "SOCKSProxy": "hostname", - "SOCKSVersion": [4, 5], - "Passthrough": "List of passthrough addresses/domains", - "AutoConfigURL": "URL_TO_AUTOCONFIG", - "AutoLogin": [true, false], - "UseProxyForDNS": [true, false] +Configure proxy settings. These settings correspond to the connection settings in Firefox preferences. +To specify ports, append them to the hostnames with a colon (:). + +`Mode` is the proxy method being used. + +`Locked` is whether or not proxy settings can be changed. + +`HTTPProxy` is the HTTP proxy server. + +`UseHTTPProxyForAllProtocols` is whether or not the HTTP proxy should be used for all other proxies. + +`SSLProxy` is the SSL proxy server. + +`FTPProxy` is the FTP proxy server. + +`SOCKSProxy` is the SOCKS proxy server + +`SOCKSVersion` is the SOCKS version (4 or 5) + +`Passthrough` is list of hostnames or IP addresses that will not be proxied. Use `` to bypass proxying for all hostnames which do not contain periods. + +`AutoConfigURL` is a URL for proxy configuration (only used if Mode is autoConfig). + +`AutoLogin` means do not prompt for authentication if password is saved. + +`UseProxyForDNS` to use proxy DNS when using SOCKS v5. + +**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` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\Proxy\Mode = "none", "system", "manual", "autoDetect", "autoConfig" +Software\Policies\Mozilla\Firefox\Proxy\Locked = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\=Proxy\HTTPProxy = https://httpproxy.example.com +Software\Policies\Mozilla\Firefox\Proxy\UseHTTPProxyForAllProtocols = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Proxy\SSLProxy = https://sslproxy.example.com +Software\Policies\Mozilla\Firefox\Proxy\FTPProxy = https://ftpproxy.example.com +Software\Policies\Mozilla\Firefox\Proxy\SOCKSProxy = https://socksproxy.example.com +Software\Policies\Mozilla\Firefox\Proxy\SOCKSVersion = 0x4 | 0x5 +Software\Policies\Mozilla\Firefox\Proxy\Passthrough = +Software\Policies\Mozilla\Firefox\Proxy\AutoConfigURL = URL_TO_AUTOCONFIG +Software\Policies\Mozilla\Firefox\Proxy\AutoLogin = 0x1 | 0x0 +Software\Policies\Mozilla\Firefox\Proxy\UseProxyForDNS = 0x1 | 0x0 +``` +#### macOS +``` + + 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 + SOCKSVersion + 4 | 5 + Passthrough + <local>> + AutoConfigURL + URL_TO_AUTOCONFIG + AutoLogin + | + UseProxyForDNS + | + + +``` +#### policies.json +``` +{ + "policies": { + "Proxy": { + "Mode": "none", "system", "manual", "autoDetect", "autoConfig", + "Locked": [true, false], + "HTTPProxy": "hostname", + "UseHTTPProxyForAllProtocols": [true, false], + "SSLProxy": "hostname", + "FTPProxy": "hostname", + "SOCKSProxy": "hostname", + "SOCKSVersion": 4 | 5 + "Passthrough": "", + "AutoConfigURL": "URL_TO_AUTOCONFIG", + "AutoLogin": [true, false], + "UseProxyForDNS": [true, false] + } + } +} +``` +### 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. + +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 (GPO) +``` +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 +``` + + RequestedLocales + + de + en-US + + + +or + + + RequestedLocales + de,en-US + + +``` +#### policies.json +``` +{ + "policies": { + "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 (GPO) +``` +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 + | + + +``` +#### policies.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` +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\SanitizeOnShutdown = 0x1 | 0x0 +``` +#### macOS +``` + + SanitizeOnShutdown + | + +``` +#### policies.json +``` +{ + "policies": { + "SanitizeOnShutdown": true | false + } +} +``` +### SearchBar +Set whether or not search bar is displayed. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** `showSearchBar`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\SearchBar = "unified" | "separate" +``` +#### macOS +``` + + SearchBar + unified | separate + +``` + +#### policies.json +``` +{ + "policies": { + "SearchBar": "unified" | "separate" + } +} +``` + + + + + +### SearchEngines (This policy is only available on the ESR.) + +### SearchEngines | Default + +Set the default search engine. This policy is only available on the ESR. + +**Compatibility:** Firefox ESR 60\ +**CCK2 Equivalent:** `defaultSearchEngine`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\SearchEngines\Default = NAME_OF_SEARCH_ENGINE +``` +#### macOS +``` + + SearchEngines + + Default + NAME_OF_SEARCH_ENGINE + + +``` +#### policies.json +``` +{ + "policies": { + "SearchEngines": { + "Default": "NAME_OF_SEARCH_ENGINE" + } + } +} +``` +### SearchEngines | PreventInstalls + +Prevent installing search engines from webpages. + +**Compatibility:** Firefox ESR 60\ +**CCK2 Equivalent:** `disableSearchEngineInstall`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\SearchEngines\PreventInstalls = 0x1 | 0x0 +``` +#### macOS +``` + + SearchEngines + + PreventInstalls + | + + +``` +#### policies.json +``` +{ + "policies": { + "SearchEngines": { + "PreventInstalls": true | false + } + } +} +``` +### SearchEngines | Remove + +Hide built-in search engines. This policy is only available on the ESR. + +**Compatibility:** Firefox ESR 60.2\ +**CCK2 Equivalent:** `removeDefaultSearchEngines` (removed all built-in engines)\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\SearchEngines\Remove\1 = NAME_OF_SEARCH_ENGINE +``` +#### macOS +``` + + SearchEngines + + Remove + + NAME_OF_SEARCH_ENGINE + + + +``` +#### policies.json +``` +{ + "policies": { + "SearchEngines": { + "Remove": ["NAME_OF_SEARCH_ENGINE"] + } + } +} +``` +### SearchEngines | Add + +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. + +`URLTemplate` is the search URL with {searchTerms} to substitute for the search term. + +`Method` is either GET or POST + +`IconURL` is a URL for the icon to use. + +`Alias` is a keyword to use for the engine. + +`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 (POST support in Firefox ESR 68)\ +**CCK2 Equivalent:** `searchplugins`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +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\IconURL = "https://www.example.org/favicon.ico" +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 +``` + + SearchEngines + + Add + + + Name + Example1 + URLTemplate + https://www.example.org/q={searchTerms} + Method + GET | POST + IconURL + https://www.example.org/favicon.ico + Alias + example + Description + Example Description + SuggestURLTemplate + https://www.example.org/suggestions/q={searchTerms} + PostData + name=value&q={searchTerms} + + + + +``` +#### policies.json +``` +{ + "policies": { + "SearchEngines": { + "Add": [ + { + "Name": "Example1", + "URLTemplate": "https://www.example.org/q={searchTerms}", + "Method": "GET" | "POST", + "IconURL": "https://www.example.org/favicon.ico", + "Alias": "example", + "Description": "Description", + "PostData": "name=value&q={searchTerms}", + "SuggestURLTemplate": "https://www.example.org/suggestions/q={searchTerms}" + } + ] + } + } +} +``` +### 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 (GPO) +``` +Software\Policies\Mozilla\Firefox\SearchSuggestEnabled = 0x1 | 0x0 +``` +#### macOS +``` + + SearchSuggestEnabled + | + +``` +#### policies.json +``` +{ + "policies": { + "SearchSuggestEnabled": true | false + } +} +``` +### SecurityDevices + +Install PKCS #11 modules. + +**Compatibility:** Firefox 64, Firefox ESR 60.4\ +**CCK2 Equivalent:** `certs.devices`\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\SecurityDevices\NAME_OF_DEVICE = PATH_TO_LIBRARY_FOR_DEVICE +``` +#### macOS +``` + + SecurityDevices + + NAME_OF_DEVICE + PATH_TO_LIBRARY_FOR_DEVICE + + +``` + +#### policies.json +``` +{ + "policies": { + "SecurityDevices": { + "NAME_OF_DEVICE": "PATH_TO_LIBRARY_FOR_DEVICE" + } + } +} +``` +### SSLVersionMax + +Set and lock the maximum version of TLS. + +**Compatibility:** Firefox 66, Firefox ESR 60.6\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `security.tls.version.max` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\SSLVersionMax = "tls1" | "tls1.1" | "tls1.2" | "tls1.3" +``` +#### macOS +``` + + SSLVersionMax + tls1 | tls1.1 | tls1.2 | tls1.3 + +``` + +#### policies.json +``` +{ + "policies": { + "SSLVersionMax": "tls1" | "tls1.1" | "tls1.2" | "tls1.3" + } +} +``` +### SSLVersionMin + +Set and lock the minimum version of TLS. + +**Compatibility:** Firefox 66, Firefox ESR 60.6\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** `security.tls.version.min` + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\SSLVersionMin = "tls1" | "tls1.1" | "tls1.2" | "tls1.3" +``` +#### macOS +``` + + SSLVersionMin + tls1 | tls1.1 | tls1.2 | tls1.3 + +``` + +#### policies.json +``` +{ + "policies": { + "SSLVersionMin": "tls1" | "tls1.1" | "tls1.2" | "tls1.3" + } +} +``` +### 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 (GPO) +``` +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 + + +``` +#### policies.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. + +**Compatibility:** Firefox 60, Firefox ESR 60\ +**CCK2 Equivalent:** N/A\ +**Preferences Affected:** N/A + +#### Windows (GPO) +``` +Software\Policies\Mozilla\Firefox\WebsiteFilters\Block\1 = "" +Software\Policies\Mozilla\Firefox\WebsiteFilters\Exceptions\1 = "http://example.org/*" +``` +#### macOS +``` + + WebsiteFilter + + Block + + + + Exceptions + + http://example.org/* + + + + +``` +#### policies.json +``` +{ + "policies": { + "WebsiteFilter": { + "Block": [""], + "Exceptions": ["http://example.org/*"] + } } } ```