Skip to content
Install in Home Assistant

Docs contents

Get started

Install Denframe in Home Assistant

Experimental

Run Denframe as a Home Assistant app (add-on), managed from Home Assistant’s sidebar.

Experimental: Installation and Ingress testing on a supervised Home Assistant, then publication to a registry. See what is still in testing.

You’ll have

Denframe running inside Home Assistant, opened from its sidebar, with your screens loading dashboards from Home Assistant’s address.

You’ll need
  • Early access from the maintainer: the approved repository and image version. No supported public release exists yet; for a desktop build see Downloads.
  • A Home Assistant installation that supports apps (add-ons), and an administrator account.
  • Screens on the same network as Home Assistant.

Follow these steps in your own Denframe. This website never connects to your household, your accounts or your devices, and never asks for your credentials.

  1. Check this is the install you want

    This runs Denframe itself inside Home Assistant. To show values from a Home Assistant you already run, Denframe does not need to be installed here: follow Show Home Assistant sensor values. To share Denframe’s actions and summaries with Home Assistant, follow Share Denframe with Home Assistant.

  2. Add the repository and install

    In Home Assistant, open Settings → Add-ons → Add-on Store (newer releases call these Apps and the App store), choose Repositories from its ⋮ menu, and add the approved repository address. Find Denframe, check the version the maintainer gave you is offered, and choose Install. Wait for the install to finish. Adding a repository alone does not guarantee an installable image.

  3. Set where screens reach it, and who owns it

    In the app’s Configuration, set receiver_base_url (Receiver URL) to the Home Assistant address your screens can reach, usually http://<ha-address>:8098. Do not use an Ingress address.

    Set owner_user_ids (Denframe owner user IDs) to your Home Assistant user ID, from your profile settings, then save. Do this before opening Denframe: only a listed owner can finish its first-run setup.

    Leave the other options as they are. Built but off in beta builds, and not offered: Denframe Cloud, Apple TV app, Direct HomeKit accessories, Denframe's own HomeKit bridge, Home controls on touch panels and Ticking Google Tasks from screens. See what is still in testing.

  4. Start it and open Denframe

    Choose Start and check the app’s log for a successful start. Turn on Show in sidebar and open Denframe from Home Assistant. Management is served through Ingress (port 8099); port 8098 is only for screens.

    Finish the first-run setup, then create your first dashboard.

  5. Check it worked

    Denframe opens from Home Assistant’s sidebar and shows Welcome to Denframe or your dashboards. Next, put a dashboard on a screen: screens load it from receiver_base_url.

If it doesn’t work

Denframe is missing from the store

Check the repository address and that the maintainer has published an image for your Home Assistant’s architecture (amd64 or aarch64).

Screens cannot load the dashboard

Check receiver_base_url is the LAN address and port 8098 the screens can reach, not an Ingress address.

Installation problems

When asking for help, include the Home Assistant version, the Denframe build and the app’s log with secrets removed.

Related guides