FirefoxHome

Customize the Firefox Home page.

Values

Each key named after a Firefox Home section is a Boolean that shows or hides that section, and Locked prevents the user from changing any of them.

Widgets controls the new tab widgets and takes two sub-keys:

• Enabled: A Boolean that shows or hides widgets as a whole. It follows Locked like the other keys.
• Blocked: A list of widget ids to turn off individually. Blocked widgets are always locked, whether or not Locked is set. The ids are clocks, crossword, focusTimer, lists, pictureOfTheDay, privacy, recentSearches, sportsWidget, stocks, and weather. An invalid widget id is ignored.

Examples

policies.json

{
  "policies": {
    "FirefoxHome": {
      "Search": true,
      "TopSites": true,
      "SponsoredTopSites": true,
      "Highlights": true,
      "Pocket": true,
      "Stories": true,
      "SponsoredPocket": true,
      "SponsoredStories": true,
      "Snippets": true,
      "Widgets": {
        "Enabled": true,
        "Blocked": [
          "crossword",
          "stocks"
        ]
      },
      "Locked": true
    }
  }
}

JSON schema

FirefoxHome JSON schema

{
  "type": "object",
  "properties": {
    "Search": {
      "type": "boolean"
    },
    "Weather": {
      "type": "boolean"
    },
    "TopSites": {
      "type": "boolean"
    },
    "SponsoredTopSites": {
      "type": "boolean"
    },
    "Highlights": {
      "type": "boolean"
    },
    "Pocket": {
      "type": "boolean"
    },
    "Stories": {
      "type": "boolean"
    },
    "SponsoredPocket": {
      "type": "boolean"
    },
    "SponsoredStories": {
      "type": "boolean"
    },
    "Snippets": {
      "type": "boolean"
    },
    "Widgets": {
      "type": "object",
      "properties": {
        "Enabled": {
          "type": "boolean"
        },
        "Blocked": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "Locked": {
      "type": "boolean"
    }
  }
}

Windows (GPO)

Software\Policies\Mozilla\Firefox\FirefoxHome\Search = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\Weather = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\TopSites = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\SponsoredTopSites = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\Highlights = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\Pocket = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\Stories = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\SponsoredPocket = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\SponsoredStories = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\Snippets = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\Widgets\Enabled = 0x1 | 0x0
Software\Policies\Mozilla\Firefox\FirefoxHome\Widgets\Blocked\1 = "crossword"
Software\Policies\Mozilla\Firefox\FirefoxHome\Locked = 0x1 | 0x0

macOS

<dict>
  <key>FirefoxHome</key>
  <dict>
    <key>Search</key>
    <true/> | <false/>
    <key>Weather</key>
    <true/> | <false/>
    <key>TopSites</key>
    <true/> | <false/>
    <key>SponsoredTopSites</key>
    <true/> | <false/>
    <key>Highlights</key>
    <true/> | <false/>
    <key>Pocket</key>
    <true/> | <false/>
    <key>Stories</key>
    <true/> | <false/>
    <key>SponsoredPocket</key>
    <true/> | <false/>
    <key>SponsoredStories</key>
    <true/> | <false/>
    <key>Snippets</key>
    <true/> | <false/>
    <key>Widgets</key>
    <dict>
      <key>Enabled</key>
      <true/> | <false/>
      <key>Blocked</key>
      <array>
        <string>crossword</string>
      </array>
    </dict>
    <key>Locked</key>
    <true/> | <false/>
  </dict>
</dict>

Compatibility

	Firefox	Firefox ESR	Firefox Enterprise
FirefoxHome	Available since 6868	Available since 6868	Available since 149149
Snippets1	Available from 68, removed in 12268 - 122	Available from 68, removed in 12868 - 128	Not supportedNo
SponsoredPocket2	Available since 9595	Available since 91.491.4	Available since 149149
SponsoredTopSites	Available since 9595	Available since 91.491.4	Available since 149149
SponsoredStories3	Available since 141141	Available since 140.1140.1	Available since 149149
Stories4	Available since 141141	Available since 140.1140.1	Available since 149149
Weather	Available since 152152	Available since 140.12140.12	Available since 152152
Widgets	Available since 156156	Not supportedNo	Available since 156156

1. Deprecated in Firefox 122.
2. Replaced by the SponsoredStories property in Firefox 141.
3. Replaces the SponsoredPocket property in Firefox 141.
4. Replaces the Pocket property.

CCK2 Equivalent: N/A
OMA-URI: FirefoxHome
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, browser.newtabpage.activity-stream.showSponsoredTopSites, browser.newtabpage.activity-stream.showSponsored, browser.newtabpage.activity-stream.showWeather, browser.newtabpage.activity-stream.widgets.enabled, browser.newtabpage.activity-stream.widgets.weather.enabled, and one browser.newtabpage.activity-stream.widgets.<id>.enabled per blocked widget