grafana/docs/sources/administration/change-home-dashboard.md
Agnès Toulet 903c76415c
Docs: Add how to replace home dashboard (#26237)
* Docs: how to replace home dashboard

* add overrides explanation

* change home dashboard v2

* Apply feedback for home dashboard doc

* home dashboard doc v3

* Apply feedback on home dashboard doc
2020-07-17 15:43:09 +02:00

3.1 KiB

+++ title = "Change the default home dashboard" description = "How to replace the default home dashboard" keywords = ["grafana", "configuration", "documentation", "home"] type = "docs" [menu.docs] name = "Home Dashboard" identifier = "change-home-dashboard" parent = "admin" weight = 100 +++

Change the default home dashboard

You can change the default dashboard on the organization, team and user level. The home dashboard you set for the whole organization is the one all users will see by default. The team dashboard applies to all users assigned to the team in Grafana. The team dashboard overrides the organization dashboard settings. Personal dashboard settings override team dashboard settings.

Set the home dashboard for your organization

Set the default dashboard through preferences

  1. Navigate to the dashboard you want to set as the home dashboard.
  2. Star this dashboard by clicking on the star next to the dashboard title.
  3. On the left menu, hover your cursor over the Configuration (gear) icon and then click Preferences.
  4. In the Home Dashboard field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards.

Set the default dashboard through configuration

If preferences are set as described above, then they override this value. You can provide your own JSON file to change the home dashboard. No user will be able to update this dashboard in Grafana.

[Optional] Convert an existing dashboard into a JSON file

  1. Navigate to your dashboard page.
  2. Click the Share dashboard icon next to the dashboard title.
  3. In the Export tab, click on Save to file.

Use a JSON file as the home dashboard

  1. Save your JSON file somewhere that Grafana can access it, for example, in the Grafana data folder of Grafana.
  2. Update your configuration file to set the path to the JSON file. Read how to update this file in the [configuration]({{< relref "./configuration.md">}}) documentation.
[dashboards]
# Path to the default home dashboard. If this value is empty, then Grafana uses StaticRootPath + "dashboards/home.json"
default_home_dashboard_path = data/main-dashboard.json

Set home dashboard for your team

  1. Navigate to the dashboard you want to set as the home dashboard.
  2. Star this dashboard by clicking on the star next to the dashboard title.
  3. On the left menu, hover your cursor over the Configuration (gear) icon and then click Teams.
  4. Click on the team you want to change the home dashboard for and then navigate to the Settings tab.
  5. In the Home Dashboard field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards.

Set your personal home dashboard

  1. Navigate to the dashboard you want to set as the home dashboard.
  2. Star this dashboard by clicking on the star next to the dashboard title.
  3. On the left menu, hover your cursor over your avatar and then click Preferences.
  4. In the Home Dashboard field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards.