Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/content/docs/reference/policies/3rdparty.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ For GPO and Intune, the extension developer should provide an ADMX file.

<PolicyExample policy="3rdparty" />

## Values

- `Extensions`: An object keyed by extension ID.
The value for each ID is the configuration passed to that extension.
Firefox does not define those keys and values, the extension does, so check the extension's documentation for what it accepts.

## macOS

```xml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ See [Configuring policies](/guides/policies-configuration/) for where each polic
> - Setting `EnterprisePoliciesEnabled` in `policies.json` has no effect and is reported as an error in `about:policies`.
> For this reason, all non-macOS sections are omitted deliberately from this page.

## Values

- Set to `true` to enable policy support on macOS, so Firefox reads the policies in the plist.
- Set to `false`, or leave the key out, and Firefox ignores every policy in the plist.

## macOS

```xml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ This policy is based on the [Chrome policy](https://chromeenterprise.google/poli

<PolicyExample policy="ExemptDomainFileTypePairsFromFileTypeDownloadWarnings" />

## Values

Each entry in the list accepts the following keys:

- `file_extension`: The file extension the exemption applies to, without a leading dot, such as `jnlp`.
- `domains`: A list of domains the exemption applies to, such as `example.com`.
These are domains, not URL patterns, and a wildcard (`*`) is not supported.

## Windows (GPO)

```
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/reference/policies/ExtensionUpdate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ Control extension updates.

<PolicyExample policy="ExtensionUpdate" />

## Values

- Set to `true` to leave extension updates enabled. This is the same as not setting the policy.
- Set to `false` to stop extensions updating, and prevent the user from turning updates back on.

## Windows (GPO)

```
Expand Down
10 changes: 10 additions & 0 deletions src/content/docs/reference/policies/FirefoxSuggest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ As of Firefox 146, `WebSuggestions` turns off Suggest completely.

<PolicyExample policy="FirefoxSuggest" />

## Values

- `WebSuggestions`: Set to `false` to turn off Firefox Suggest.
- `SponsoredSuggestions`: Set to `false` to stop sponsored suggestions appearing.
- `OnlineEnabled`: Set to `false` to limit Firefox Suggest to suggestions stored locally, rather than fetched as the user types.
- `ImproveSuggest`: Deprecated, use `OnlineEnabled` instead.
- `Locked`: Prevents the user from changing these settings.

Values are applied as defaults that users can change, unless `Locked` is set to `true`.

## Windows (GPO)

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ Whether to always go through the DNS server before sending a single word search

<PolicyExample policy="GoToIntranetSiteForSingleWordEntryInAddressBar" />

## Values

- Set to `true` to send a single word entry to the DNS server before the search engine, and lock the setting.
- Set to `false` to send a single word entry straight to the search engine, and lock the setting.

## Description

If the site exists, it will navigate to the website.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ Control hardware acceleration.

<PolicyExample policy="HardwareAcceleration" />

## Values

- Set to `true` to leave hardware acceleration enabled. This is the same as not setting the policy.
- Set to `false` to disable hardware acceleration, and prevent the user from turning it back on.

## Windows (GPO)

```
Expand Down
6 changes: 6 additions & 0 deletions src/content/docs/reference/policies/HttpAllowlist.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ The sites are specified as a list of origins.

<PolicyExample policy="HttpAllowlist" />

## Values

`HttpAllowlist` expects a list of origins that are not upgraded to HTTPS, such as `http://example.org`.
Each entry is a scheme, hostname and optional port.
Paths and wildcards are not supported.

## Windows (GPO)

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ Prevent the built-in VPN from being available to users.

<PolicyExample policy="IPProtectionAvailable" />

## Values

- Set to `true` to leave the built-in VPN available. This is the same as not setting the policy.
- Set to `false` to make the built-in VPN unavailable to users.

## Windows (GPO)

```
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/reference/policies/LegacyProfiles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ Windows only, GPO only.
}
```

## Values

- Set to `true` to share one profile across every installation, the same as the `MOZ_LEGACY_PROFILES` environment variable.
- Set to `false` to create a separate profile for each installation. This is the same as not setting the policy.

## Windows (GPO)

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ If this policy is set to true, it reverts all cookies to legacy SameSite behavio

<PolicyExample policy="LegacySameSiteCookieBehaviorEnabled" />

## Values

- Set to `true` to treat cookies with no `SameSite` attribute as `SameSite=None`.
- Set to `false` to treat them as `SameSite=Lax`.

The policy sets the default behavior rather than locking it, so a user can still change it.

## Windows (GPO)

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ If this policy is set to true, cookies set for domains in this list will revert

<PolicyExample policy="LegacySameSiteCookieBehaviorEnabledForDomainList" />

## Values

`LegacySameSiteCookieBehaviorEnabledForDomainList` expects a list of domains, such as `example.org`.
Cookies set for those domains revert to legacy `SameSite` behavior.

The policy sets the default behavior rather than locking it, so a user can still change it.

## Windows (GPO)

```
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/reference/policies/LocalFileLinks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ Intranet applications may need this, for example, to link to files on a shared d

<PolicyExample policy="LocalFileLinks" />

## Values

`LocalFileLinks` expects a list of origins allowed to link to `file:///` URLs, such as `http://example.org/`.
Each origin is a scheme, hostname and optional port.

## Windows (GPO)

```
Expand Down
19 changes: 14 additions & 5 deletions src/content/docs/reference/policies/ManagedBookmarks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ The bookmarks are only added as a button on the personal toolbar, they are not i

The syntax of this policy is based on the [Chrome ManagedBookmarks policy](https://cloud.google.com/docs/chrome-enterprise/policies/?policy=ManagedBookmarks), with the addition of the Firefox-specific `favicon` property.

A `favicon` can be specified for each bookmark.
The value must be a `data:`, `http:`, or `https:` URL.

A bookmark's `url` can be a `javascript:` URL to create a bookmarklet.

## Compatibility

<PolicyCompat policy="ManagedBookmarks" />
Expand All @@ -28,6 +23,20 @@ A bookmark's `url` can be a `javascript:` URL to create a bookmarklet.

<PolicyExample policy="ManagedBookmarks" />

## Values

The first entry in the list names the toolbar folder, and the entries after it are the bookmarks:

- `toplevel_name`: The name of the folder button added to the bookmarks toolbar.
Only used in the first entry.
- `name`: The name shown for a bookmark or folder.
- `url`: The address the bookmark opens.
A `javascript:` URL creates a bookmarklet.
- `favicon`: The URL of an icon to show for the bookmark.
Must be a `data:`, `http:` or `https:` URL.
- `children`: A list of bookmarks to put in a folder.
Folders can be nested.

## Windows (GPO)

Software\Policies\Mozilla\Firefox\ManagedBookmarks (REG_MULTI_SZ) =
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/reference/policies/ManualAppUpdateOnly.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ This policy is primarily intended for advanced end users, not for enterprises, b

<PolicyExample policy="ManualAppUpdateOnly" />

## Values

- Set to `true` to switch to manual updates only.
- Set to `false` to leave automatic update checking enabled. This is the same as not setting the policy.

## Windows (GPO)

```
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/reference/policies/MicrosoftEntraSSO.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ For the Windows equivalent, see the [`WindowsSSO`](/reference/policies/windowsss

<PolicyExample policy="MicrosoftEntraSSO" />

## Values

- Set to `true` to enable single sign-on for Microsoft Entra accounts, and lock the setting.
- Set to `false` to disable single sign-on for Microsoft Entra accounts, and lock the setting.

## macOS

```xml
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/reference/policies/NetworkPrediction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ Enable or disable network prediction ([DNS prefetching](https://developer.mozill

<PolicyExample policy="NetworkPrediction" />

## Values

- Set to `true` to allow DNS prefetching, and lock the setting.
- Set to `false` to stop DNS prefetching, over both HTTP and HTTPS, and lock the setting.

## Windows (GPO)

```
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/reference/policies/NewTabPage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ To keep the New Tab page but change which sections appear on it, use the [`Firef

<PolicyExample policy="NewTabPage" />

## Values

- Set to `true` to open Firefox Home on new tabs, and lock the setting.
- Set to `false` to open a blank page on new tabs, and lock the setting.

## Windows (GPO)

```
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/reference/policies/NoDefaultBookmarks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ This policy is only effective if the user profile has not been created yet.

<PolicyExample policy="NoDefaultBookmarks" />

## Values

- Set to `true` to stop Firefox creating the default bookmarks.
- Set to `false` to create the default bookmarks. This is the same as not setting the policy.

## Windows (GPO)

```
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/reference/policies/OfferToSaveLogins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ Control whether or not Firefox offers to save passwords.

<PolicyExample policy="OfferToSaveLogins" />

## Values

- Set to `true` to offer to save logins and passwords, and prevent the user from changing it.
- Set to `false` to stop offering to save logins and passwords, and prevent the user from changing it.

## Windows (GPO)

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ Sets the default value of `signon.rememberSignons` without locking it.

<PolicyExample policy="OfferToSaveLoginsDefault" />

## Values

- Set to `true` to offer to save logins and passwords by default. The user can still change it.
- Set to `false` to not offer to save logins and passwords by default. The user can still change it.

If [`OfferToSaveLogins`](/reference/policies/offertosavelogins/) is also set, it takes precedence and `OfferToSaveLoginsDefault` is ignored.

## Windows (GPO)

```
Expand Down
10 changes: 9 additions & 1 deletion src/content/docs/reference/policies/OverrideFirstRunPage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Override the first run page."
category: "Startup"
---

Override the first run page. If the value is an empty string (`""`), the first run page is not displayed.
Override the first run page.

The first run page is what Firefox opens the first time a new profile is used, normally the onboarding tour at `about:welcome`.
Setting this policy replaces that page and turns the onboarding tour off, so users go directly to the URL you specify.
Expand All @@ -24,6 +24,14 @@ For the page shown after Firefox updates, see the [`OverridePostUpdatePage`](/re

<PolicyExample policy="OverrideFirstRunPage" />

## Values

`OverrideFirstRunPage` expects the URL to show the first time a new profile is used:

- A URL, such as `https://example.com`, replaces the onboarding tour with that page.
Multiple URLs can be separated by a vertical bar (`|`), each opening in its own tab.
- An empty string (`""`) shows no first run page at all.

## Windows (GPO)

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Override the upgrade page."
category: "Startup"
---

Override the upgrade page. If the value is an empty string (`""`), no extra pages are displayed when Firefox is upgraded.
Override the upgrade page.

The upgrade page, also called the "What's New" page, is the extra tab Firefox opens the first time it starts after updating to a new version.
It is normally a page on mozilla.org describing what changed in that release.
Expand All @@ -23,6 +23,13 @@ For the page shown the first time a new profile is used, see the [`OverrideFirst

<PolicyExample policy="OverridePostUpdatePage" />

## Values

`OverridePostUpdatePage` expects the URL to show the first time Firefox starts after an update:

- A URL, such as `https://example.com`, replaces the What's New page with that page.
- An empty string (`""`) shows no page after an update.

## Windows (GPO)

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ Remove access to the password manager via preferences and block `about:logins`.

<PolicyExample policy="PasswordManagerEnabled" />

## Values

- Set to `true` to keep the password manager available and offer to save logins, and lock the setting.
- Set to `false` to block `about:logins`, remove password management from settings, and stop Firefox saving logins.

## Windows (GPO)

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ The sites are specified as a list of origins.

<PolicyExample policy="PasswordManagerExceptions" />

## Values

`PasswordManagerExceptions` expects a list of origins Firefox never offers to save passwords for, such as `https://example.org`.
Each origin is a scheme, hostname and optional port.
Paths and wildcards are not supported.

## Windows (GPO)

```
Expand Down
7 changes: 7 additions & 0 deletions src/content/docs/reference/policies/PictureInPicture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ Enable or disable [Picture-in-Picture](https://support.mozilla.org/en-US/kb/abou

<PolicyExample policy="PictureInPicture" />

## Values

- `Enabled`: Set to `true` to make the Picture-in-Picture toggle available, or `false` to remove it.
- `Locked`: Set to `true` to prevent the user from changing the setting.

`Enabled` is applied as a default that users can change, unless `Locked` is set to `true`.

## Windows (GPO)

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ This policy is independent of [`CNSA2KeyAgreementEnabled`](/reference/policies/c

<PolicyExample policy="PostQuantumKeyAgreementEnabled" />

## Values

- Set to `true` to enable post-quantum key agreement for TLS, HTTP/3 and WebRTC, and lock the settings.
- Set to `false` to disable post-quantum key agreement for TLS, HTTP/3 and WebRTC, and lock the settings.

## Windows (GPO)

```
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/reference/policies/PrimaryPassword.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ If both `DisableMasterPasswordCreation` and `PrimaryPassword` are used, `Disable

<PolicyExample policy="PrimaryPassword" />

## Values

- Set to `true` to require a primary password, and stop the user removing it.
- Set to `false` to remove primary password functionality, the same as setting [`DisableMasterPasswordCreation`](/reference/policies/disablemasterpasswordcreation/) to `true`.

## Windows (GPO)

```
Expand Down
Loading