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
28 changes: 26 additions & 2 deletions src/content/docs/reference/policies/FirefoxHome.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,28 @@ Customize the Firefox Home page.

<PolicyCompat policy="FirefoxHome" />

`SponsoredTopSites` and `SponsoredPocket` were added in Firefox 95, Firefox ESR 91.4, `Snippets` was deprecated in Firefox 122, `Stories` and `SponsoredStories` were added in Firefox 141 to replace `Pocket` and `SponsoredPocket`, `Weather` was added in Firefox 152, Firefox ESR 140.12.
`SponsoredTopSites` and `SponsoredPocket` were added in Firefox 95, Firefox ESR 91.4, `Snippets` was deprecated in Firefox 122, `Stories` and `SponsoredStories` were added in Firefox 141 to replace `Pocket` and `SponsoredPocket`, `Weather` was added in Firefox 152, Firefox ESR 140.12, and `Widgets` was added in Firefox 156.

**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`, `browser.newtabpage.activity-stream.showSponsoredTopSites`, `browser.newtabpage.activity-stream.showSponsored`, `browser.newtabpage.activity-stream.showWeather`
**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

## Examples

<PolicyExample policy="FirefoxHome" />

## 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.

## Windows (GPO)

```
Expand All @@ -32,6 +45,8 @@ 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
```

Expand Down Expand Up @@ -61,6 +76,15 @@ Software\Policies\Mozilla\Firefox\FirefoxHome\Locked = 0x1 | 0x0
<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>
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/reference/policies/SitePolicies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ Currently the supported site policies are:
- `HttpsOnly` stops the site from being loaded over plain HTTP when `true`.
When it is `false`, HTTP is explicitly allowed for the site, which is how you carve a site out of a broader rule.

- `DisableServiceWorkers` stops the site from registering or using [service workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) when `true`.
Only `http` and `https` sites are affected, and sites relying on service workers for offline support or push notifications will lose those features.

## Windows (GPO)

```
Expand Down