Homepage

Configure the default homepage and how Firefox starts.

This policy covers startup and the Home button. It does not change what a new tab shows: use the NewTabPage policy to turn the New Tab page off, or the FirefoxHome policy to change the sections on it.

Values

The following members are configurable:

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. Expects one of the following values:
- none: Start with a blank page (no homepage, no previous session).
- homepage: Start with the homepage in URL policy.
- previous-session: Restore the previous session (all tabs and windows reopen).
- homepage-locked: Always force the homepage at startup, users cannot choose session restore.
NewTabOnRestore controls the "Also open new tab" option under Settings, in the Startup section. When it is enabled, Firefox opens an extra tab whenever it restores your previous windows and tabs at startup. Firefox may turn this option on for your users on its own, so set NewTabOnRestore to false to keep it off, or true to always enable it.

Examples

{
  "policies": {
    "Homepage": {
      "URL": "http://example.com/",
      "Locked": true,
      "Additional": [
        "http://example.org/",
        "http://example.edu/"
      ],
      "StartPage": "none"
    }
  }
}

JSON schema

{
  "type": "object",
  "properties": {
    "URL": {
      "type": "string",
      "format": "moz-url"
    },
    "Locked": {
      "type": "boolean"
    },
    "Additional": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "moz-url"
      }
    },
    "StartPage": {
      "type": "string",
      "oneOf": [
        {
          "const": "none",
          "title": "Blank page"
        },
        {
          "const": "homepage",
          "title": "Homepage"
        },
        {
          "const": "previous-session",
          "title": "Previous session"
        },
        {
          "const": "homepage-locked",
          "title": "Homepage, locked"
        }
      ]
    },
    "NewTabOnRestore": {
      "type": "boolean"
    }
  }
}

Setting a company SSO portal as the default homepage

This example sets your company's single sign-on (SSO) portal as the default homepage and startup page, so that users can sign in and open your company's apps. Users can still change both settings, and existing user choices take precedence over these defaults. Setting URL also adds the Home button to the default toolbar:

{
  "policies": {
    "Homepage": {
      "URL": "https://sso.example.com/",
      "StartPage": "homepage"
    }
  }
}

Enforcing a homepage on every start

This example opens your company's SSO portal whenever Firefox starts and stops users from changing the homepage address. Locked locks only the homepage address, and StartPage: "homepage-locked" locks how Firefox starts, so both are necessary:

{
  "policies": {
    "Homepage": {
      "URL": "https://sso.example.com/",
      "Locked": true,
      "StartPage": "homepage-locked"
    }
  }
}

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" | "homepage-locked"
Software\Policies\Mozilla\Firefox\Homepage\NewTabOnRestore = 0x1 | 0x0

macOS

<dict>
  <key>Homepage</key>
  <dict>
    <key>URL</key>
    <string>http://example.com</string>
    <key>Locked</key>
    <true/> | <false/>
    <key>Additional</key>
    <array>
      <string>http://example.org</string>
      <string>http://example.edu</string>
    </array>
    <key>StartPage</key>
    <string>none | homepage | previous-session | homepage-locked</string>
    <key>NewTabOnRestore</key>
    <true/> | <false/>
  </dict>
</dict>

Compatibility

	Firefox	Firefox ESR	Firefox Enterprise
`Homepage`	Available since 60	Available since 60	Available since 149
`StartPage`¹	Available since 64	Available since 60.4	Available since 149
`NewTabOnRestore`	Available since 153	Available since 153	Available since 153

The homepage-locked value was added in Firefox 78.

CCK2 Equivalent: homePage,lockHomePage
OMA-URI: Homepage
Preferences Affected: browser.startup.homepage, browser.startup.page, browser.sessionstore.newTabOnRestore, browser.sessionstore.newTabOnRestore.showSetting