Skip to content

🚀 Installation#

⚙️ Prerequisites#

Mushroom dashboard strategy and dependencies are available in HACS (Home Assistant Community Store).
Install HACS if you don't have it already.
For assistance, you can follow the installation guide.

Once you have HACS installed, you can install custom integration and plug-ins.
This guide offers you badges to open your Home Assistant on the correct page.
If the badges don't work, try installing from HACS manually:

  1. Open HACS in Home Assistant (Usually in the menu on the left side).
  2. At the top, search for the component you want to install.
  3. Select the three-dot menu on the right side of the component and select Download.
  4. Choose the desired version and select Download again.

You need to install the following HACS integrations before you can use this strategy.
Click the badges below and follow the installation instructions.
They will open the HACS repository at your Home Assistant instance directly.

Open in HACS at your Home Assistant instance. to install Mushroom.
Open in HACS at your Home Assistant instance. to install Mini graph card.

🛠️ Dashboard Installation#

If you meet all the prerequisites, click the badge below to install the strategy.

Open in HACS at your Home Assistant instance.

🛠️ Local Installation#

Please install the strategy with HACS as described above.
If you require testing a custom build for debug purposes, follow these steps:

  1. Build the strategy with npm build or npm build-dev.
  2. Copy the build file(s) to folder <your-hass-directory>/www/community/mushroom-strategy.
  3. If file mushroom-strategy.js.gz exists in that folder, rename or delete it.

Note

Refresh the cache of the client you use to access Home Assistant.

🔄 Updating#

By default, Home Assistant will notify you when an update of the strategy is available.
You can update the strategy by going to Settings found at the bottom of the sidebar.

Tip

You can enable notifications of pre-releases.

  • Go to Settings > Devices & services > Entities.
  • Search for Mushroom Dashboard and switch on the Pre-release entity.