Customize Firefox Home (Mozilla Firefox Group Policy)

What it does

If this policy is enabled, you can choose the sections displayed on Firefox Home and prevent the user from changing them. If this policy is disabled or not configured, the default sections are displayed and the user can change them.

What it writes

Hive: HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER
Registry key: Software\Policies\Mozilla\Firefox

Options

Option	Type	Registry value	Allowed values
Search	Checkbox	`Software\Policies\Mozilla\Firefox\FirefoxHomeSearch`	On (1) or off (0)
Top Sites	Checkbox	`Software\Policies\Mozilla\Firefox\FirefoxHomeTopSites`	On (1) or off (0)
Sponsored Top Sites	Checkbox	`Software\Policies\Mozilla\Firefox\FirefoxHomeSponsoredTopSites`	On (1) or off (0)
Download History	Checkbox	`Software\Policies\Mozilla\Firefox\FirefoxHomeHighlights`	On (1) or off (0)
Recommended by Pocket	Checkbox	`Software\Policies\Mozilla\Firefox\FirefoxHomePocket`	On (1) or off (0)
Sponsored Pocket Stories	Checkbox	`Software\Policies\Mozilla\Firefox\FirefoxHomeSponsoredPocket`	On (1) or off (0)
Snippets	Checkbox	`Software\Policies\Mozilla\Firefox\FirefoxHomeSnippets`	On (1) or off (0)
Don't allow settings to be changed	Checkbox	`Software\Policies\Mozilla\Firefox\FirefoxHomeLocked`	On (1) or off (0)

Configure and deploy

Choose a state and the option values; the output below is generated from the template for exactly that.

Enabled · Computer · template defaults

Registry file (.reg)

Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome]
"Highlights"=dword:00000001
"Locked"=dword:00000001
"Pocket"=dword:00000001
"Search"=dword:00000001
"Snippets"=dword:00000001
"SponsoredPocket"=dword:00000001
"SponsoredTopSites"=dword:00000001
"TopSites"=dword:00000001

PowerShell

$ErrorActionPreference = 'Stop'

function Set-RegistryValue {
    param(
        [Parameter(Mandatory = $true)][string] $Path,
        [Parameter(Mandatory = $true)][string] $Name,
        [Parameter(Mandatory = $true)][string] $PropertyType,
        [Parameter(Mandatory = $true)][object] $Value
    )

    if (-not (Test-Path -LiteralPath $Path)) {
        New-Item -Path $Path -Force | Out-Null
    }

    New-ItemProperty -LiteralPath $Path -Name $Name -PropertyType $PropertyType -Value $Value -Force | Out-Null
}

function Remove-RegistryValue {
    param(
        [Parameter(Mandatory = $true)][string] $Path,
        [Parameter(Mandatory = $true)][string] $Name
    )

    if (Test-Path -LiteralPath $Path) {
        Remove-ItemProperty -LiteralPath $Path -Name $Name -Force -ErrorAction SilentlyContinue
    }
}

function Clear-RegistryKeyValues {
    param(
        [Parameter(Mandatory = $true)][string] $Path
    )

    if (-not (Test-Path -LiteralPath $Path)) {
        return
    }

    foreach ($propertyName in (Get-Item -LiteralPath $Path).Property) {
        Remove-ItemProperty -LiteralPath $Path -Name $propertyName -Force -ErrorAction SilentlyContinue
    }
}

# Policy: Customize Firefox Home
# Name: CustomizeFirefoxHome
# Scope: Machine
# State: Enabled
# Source: firefox.admx

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Search' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'TopSites' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'SponsoredTopSites' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Highlights' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Pocket' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'SponsoredPocket' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Snippets' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Locked' -PropertyType 'DWord' -Value 1

The OMA-URI is an inferred ADMX-backed Policy CSP candidate derived from the source ADMX file name and policy name.
Some Microsoft policies use built-in Policy CSP pages whose area names don't match the ADMX file name, so verify the candidate against Microsoft Learn before deployment.
The generated payload is incomplete because one or more ADMX element values were not supplied: FirefoxHome_Search, FirefoxHome_TopSites, FirefoxHome_SponsoredTopSites, FirefoxHome_Highlights, FirefoxHome_Pocket, FirefoxHome_SponsoredPocket, FirefoxHome_Snippets, FirefoxHome_Locked

ADMX profile candidate (OMA-URI)

./Device/Vendor/MSFT/Policy/Config/ADMX_firefox/CustomizeFirefoxHome

Intune remediation scripts

Detection

$ErrorActionPreference = 'Stop'
$reasons = [System.Collections.Generic.List[string]]::new()

function Test-RegistryValueExists {
    param(
        [Parameter(Mandatory = $true)][string] $Path,
        [Parameter(Mandatory = $true)][string] $Name
    )

    if (-not (Test-Path -LiteralPath $Path)) {
        return $false
    }

    return $null -ne (Get-ItemProperty -LiteralPath $Path -Name $Name -ErrorAction SilentlyContinue)
}

function Test-RegistryValueEquals {
    param(
        [Parameter(Mandatory = $true)][string] $Path,
        [Parameter(Mandatory = $true)][string] $Name,
        [Parameter(Mandatory = $true)][string] $Kind,
        [Parameter(Mandatory = $true)][object] $Expected
    )

    if (-not (Test-Path -LiteralPath $Path)) {
        return $false
    }

    $valueObject = Get-ItemProperty -LiteralPath $Path -Name $Name -ErrorAction SilentlyContinue
    if ($null -eq $valueObject) {
        return $false
    }

    $actual = $valueObject.$Name
    switch ($Kind) {
        'String' { return [string]$actual -ceq [string]$Expected }
        'ExpandString' { return [string]$actual -ceq [string]$Expected }
        'DWord' { return [uint32]$actual -eq [uint32]$Expected }
        'QWord' { return [uint64]$actual -eq [uint64]$Expected }
        'MultiString' {
            $actualArray = @($actual)
            $expectedArray = @($Expected)
            if ($actualArray.Count -ne $expectedArray.Count) { return $false }
            for ($index = 0; $index -lt $actualArray.Count; $index++) {
                if ([string]$actualArray[$index] -cne [string]$expectedArray[$index]) { return $false }
            }
            return $true
        }
        'Binary' {
            $actualArray = [byte[]]$actual
            $expectedArray = [byte[]]$Expected
            if ($actualArray.Length -ne $expectedArray.Length) { return $false }
            for ($index = 0; $index -lt $actualArray.Length; $index++) {
                if ($actualArray[$index] -ne $expectedArray[$index]) { return $false }
            }
            return $true
        }
        default { return [string]$actual -ceq [string]$Expected }
    }
}

# Policy: Customize Firefox Home
# Name: CustomizeFirefoxHome
# Scope: Machine
# State: Enabled
# Source: firefox.admx

$isMatch = Test-RegistryValueEquals -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Search' -Kind 'DWord' -Expected 1
if (-not $isMatch) {
    $reasons.Add('Value mismatch: HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome\Search') | Out-Null
}

$isMatch = Test-RegistryValueEquals -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'TopSites' -Kind 'DWord' -Expected 1
if (-not $isMatch) {
    $reasons.Add('Value mismatch: HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome\TopSites') | Out-Null
}

$isMatch = Test-RegistryValueEquals -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'SponsoredTopSites' -Kind 'DWord' -Expected 1
if (-not $isMatch) {
    $reasons.Add('Value mismatch: HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome\SponsoredTopSites') | Out-Null
}

$isMatch = Test-RegistryValueEquals -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Highlights' -Kind 'DWord' -Expected 1
if (-not $isMatch) {
    $reasons.Add('Value mismatch: HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome\Highlights') | Out-Null
}

$isMatch = Test-RegistryValueEquals -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Pocket' -Kind 'DWord' -Expected 1
if (-not $isMatch) {
    $reasons.Add('Value mismatch: HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome\Pocket') | Out-Null
}

$isMatch = Test-RegistryValueEquals -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'SponsoredPocket' -Kind 'DWord' -Expected 1
if (-not $isMatch) {
    $reasons.Add('Value mismatch: HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome\SponsoredPocket') | Out-Null
}

$isMatch = Test-RegistryValueEquals -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Snippets' -Kind 'DWord' -Expected 1
if (-not $isMatch) {
    $reasons.Add('Value mismatch: HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome\Snippets') | Out-Null
}

$isMatch = Test-RegistryValueEquals -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Locked' -Kind 'DWord' -Expected 1
if (-not $isMatch) {
    $reasons.Add('Value mismatch: HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome\Locked') | Out-Null
}

if ($reasons.Count -eq 0) {
    Write-Output 'Compliant'
    exit 0
}

$reasons | ForEach-Object { Write-Output $_ }
exit 1

Remediation

$ErrorActionPreference = 'Stop'

function Set-RegistryValue {
    param(
        [Parameter(Mandatory = $true)][string] $Path,
        [Parameter(Mandatory = $true)][string] $Name,
        [Parameter(Mandatory = $true)][string] $PropertyType,
        [Parameter(Mandatory = $true)][object] $Value
    )

    if (-not (Test-Path -LiteralPath $Path)) {
        New-Item -Path $Path -Force | Out-Null
    }

    New-ItemProperty -LiteralPath $Path -Name $Name -PropertyType $PropertyType -Value $Value -Force | Out-Null
}

function Remove-RegistryValue {
    param(
        [Parameter(Mandatory = $true)][string] $Path,
        [Parameter(Mandatory = $true)][string] $Name
    )

    if (Test-Path -LiteralPath $Path) {
        Remove-ItemProperty -LiteralPath $Path -Name $Name -Force -ErrorAction SilentlyContinue
    }
}

function Clear-RegistryKeyValues {
    param(
        [Parameter(Mandatory = $true)][string] $Path
    )

    if (-not (Test-Path -LiteralPath $Path)) {
        return
    }

    foreach ($propertyName in (Get-Item -LiteralPath $Path).Property) {
        Remove-ItemProperty -LiteralPath $Path -Name $propertyName -Force -ErrorAction SilentlyContinue
    }
}

# Policy: Customize Firefox Home
# Name: CustomizeFirefoxHome
# Scope: Machine
# State: Enabled
# Source: firefox.admx

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Search' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'TopSites' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'SponsoredTopSites' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Highlights' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Pocket' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'SponsoredPocket' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Snippets' -PropertyType 'DWord' -Value 1

Set-RegistryValue -Path 'Registry::HKEY_LOCAL_MACHINE\Software\Policies\Mozilla\Firefox\FirefoxHome' -Name 'Locked' -PropertyType 'DWord' -Value 1

History 85 retained releases

7.513 Nov 2025
- Translations changed; choose a language above to compare its wording.
7.415 Oct 2025
- Renamed Customize Firefox Home[added: (Moved to category)]
7.220 Aug 2025
- Option “Shortcuts” ~~[was: Top Sites]~~[now: Shortcuts]
- Option “Sponsored shortcuts” Sponsored ~~[removed: Top Sites]~~[added: shortcuts]
- Option “Recent activity” ~~[was: Download History]~~[now: Recent activity]
- Option “Recommended stories” Recommended ~~[removed: by Pocket]~~[added: stories]
- Option “Sponsored stories” Sponsored ~~[removed: Pocket Stories]~~[added: stories]
- Option “Snippets (deprecated)” Snippets[added: (deprecated)]
- Editor controls or their defaults changed.
6.69 Jan 2025
- Translations changed; choose a language above to compare its wording.
6.526 Nov 2024
- Translations changed; choose a language above to compare its wording.
6.011 Jul 2024
- Translations changed; choose a language above to compare its wording.
4.126 Jun 2023
- Translations changed; choose a language above to compare its wording.
4.418 Oct 2022
- Translations changed; choose a language above to compare its wording.
3.102 Jun 2022
- Translations changed; choose a language above to compare its wording.
3.99 May 2022
- Translations changed; choose a language above to compare its wording.
3.48 Dec 2021
- New option [added: Sponsored Top Sites (FirefoxHome_SponsoredTopSites)]
- New option [added: Sponsored Pocket Stories (FirefoxHome_SponsoredPocket)]
- Editor controls or their defaults changed.
2.1019 Apr 2021
- Translations changed; choose a language above to compare its wording.
2.823 Feb 2021
- Translations changed; choose a language above to compare its wording.
1.174 Jun 2020
- Translations changed; choose a language above to compare its wording.
1.113 Dec 2019
- Translations changed; choose a language above to compare its wording.
1.1023 Oct 2019
- Translations changed; choose a language above to compare its wording.
1.8.229 Jul 2019
- Added in this release.

62 later releases left it unchanged.

Template

Internal name: CustomizeFirefoxHome
Namespace: Mozilla.Policies.Firefox
Template file: firefox.admx
Release: Mozilla Firefox 3.9 · file set 46eea69011fff735…

Definition, editor controls and support

Definition

<policy class="Both" displayName="$(string.FirefoxHome)" explainText="$(string.FirefoxHome_Explain)" key="Software\Policies\Mozilla\Firefox" name="CustomizeFirefoxHome" presentation="$(presentation.FirefoxHome)" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
      <parentCategory ref="Mozilla.Policies.Firefox:firefox" />
      <supportedOn ref="Mozilla.Policies.Firefox:SUPPORTED_FF68" />
      <elements>
        <boolean id="FirefoxHome_Search" key="Software\Policies\Mozilla\Firefox\FirefoxHome" valueName="Search">
          <trueValue>
            <decimal value="1" />
          </trueValue>
          <falseValue>
            <decimal value="0" />
          </falseValue>
        </boolean>
        <boolean id="FirefoxHome_TopSites" key="Software\Policies\Mozilla\Firefox\FirefoxHome" valueName="TopSites">
          <trueValue>
            <decimal value="1" />
          </trueValue>
          <falseValue>
            <decimal value="0" />
          </falseValue>
        </boolean>
        <boolean id="FirefoxHome_SponsoredTopSites" key="Software\Policies\Mozilla\Firefox\FirefoxHome" valueName="SponsoredTopSites">
          <trueValue>
            <decimal value="1" />
          </trueValue>
          <falseValue>
            <decimal value="0" />
          </falseValue>
        </boolean>
        <boolean id="FirefoxHome_Highlights" key="Software\Policies\Mozilla\Firefox\FirefoxHome" valueName="Highlights">
          <trueValue>
            <decimal value="1" />
          </trueValue>
          <falseValue>
            <decimal value="0" />
          </falseValue>
        </boolean>
        <boolean id="FirefoxHome_Pocket" key="Software\Policies\Mozilla\Firefox\FirefoxHome" valueName="Pocket">
          <trueValue>
            <decimal value="1" />
          </trueValue>
          <falseValue>
            <decimal value="0" />
          </falseValue>
        </boolean>
        <boolean id="FirefoxHome_SponsoredPocket" key="Software\Policies\Mozilla\Firefox\FirefoxHome" valueName="SponsoredPocket">
          <trueValue>
            <decimal value="1" />
          </trueValue>
          <falseValue>
            <decimal value="0" />
          </falseValue>
        </boolean>
        <boolean id="FirefoxHome_Snippets" key="Software\Policies\Mozilla\Firefox\FirefoxHome" valueName="Snippets">
          <trueValue>
            <decimal value="1" />
          </trueValue>
          <falseValue>
            <decimal value="0" />
          </falseValue>
        </boolean>
        <boolean id="FirefoxHome_Locked" key="Software\Policies\Mozilla\Firefox\FirefoxHome" valueName="Locked">
          <trueValue>
            <decimal value="1" />
          </trueValue>
          <falseValue>
            <decimal value="0" />
          </falseValue>
        </boolean>
      </elements>
    </policy>

Editor controls

<presentation id="FirefoxHome" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
        <checkBox refId="FirefoxHome_Search">Search</checkBox>
        <checkBox refId="FirefoxHome_TopSites">Top Sites</checkBox>
        <checkBox refId="FirefoxHome_SponsoredTopSites">Sponsored Top Sites</checkBox>
        <checkBox refId="FirefoxHome_Highlights">Download History</checkBox>
        <checkBox refId="FirefoxHome_Pocket">Recommended by Pocket</checkBox>
        <checkBox refId="FirefoxHome_SponsoredPocket">Sponsored Pocket Stories</checkBox>
        <checkBox refId="FirefoxHome_Snippets">Snippets</checkBox>
        <checkBox refId="FirefoxHome_Locked">Don't allow settings to be changed</checkBox>
      </presentation>

Supported platforms and category

Mozilla.Policies.Firefox:category:firefox
<category displayName="$(string.firefox)" name="firefox" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
      <parentCategory ref="Mozilla.Policies:Cat_Mozilla" />
    </category>
Mozilla.Policies.Firefox:definition:SUPPORTED_FF68
<definition displayName="$(string.SUPPORTED_FF68)" name="SUPPORTED_FF68" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions" />
Mozilla.Policies:category:Cat_Mozilla
<category displayName="$(string.mozilla)" name="Cat_Mozilla" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions" />
Mozilla.Policies.Firefox:category:firefox
<category displayName="$(string.firefox)" name="firefox" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions">
      <parentCategory ref="Mozilla.Policies:Cat_Mozilla" />
    </category>
<strings><string id="Mozilla.Policies.Firefox:firefox">Firefox</string></strings>
Mozilla.Policies.Firefox:definition:SUPPORTED_FF68
<definition displayName="$(string.SUPPORTED_FF68)" name="SUPPORTED_FF68" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions" />
<strings><string id="Mozilla.Policies.Firefox:SUPPORTED_FF68">Firefox 68 or later, Firefox 68 ESR or later</string></strings>
Mozilla.Policies:category:Cat_Mozilla
<category displayName="$(string.mozilla)" name="Cat_Mozilla" xmlns="http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions" />
<strings><string id="Mozilla.Policies:mozilla">Mozilla</string></strings>