homelab

How to Set Up Home Assistant Chromium Dashboard in Kiosk Mode

10/2/2024
How to Set Up Home Assistant Chromium Dashboard in Kiosk Mode

Setting Up Chromium in Kiosk Mode to Run a Home Assistant Dashboard on a Touchscreen Device (Debian)

I’ve recently gone through the process of setting up a touchscreen device to run my Home Assistant dashboard in kiosk mode on Debian, and I wanted to share the steps I took to get it up and running smoothly. To make the process easier for anyone looking to do the same, I’ve created a script that automates most of the setup, including turning off the mouse pointer and configuring Chromium to launch in full-screen kiosk mode.

Home Assistant dashboard running in Chromium kiosk mode

Choosing Chromium for Kiosk Mode

I’ve been trying different ways to display my Home Assistant dashboard, and after trying a few different approaches (including cheap android tablets and browsers like Fully), I found that the best solution was to use a dedicated touchscreen device with Chromium running in kiosk mode on Debian. This setup offers a clean, full-screen interface that loads the dashboard automatically and eliminates the need for any unnecessary browser UI.

Benefits:

My Setup:

Installing Sudo

One thing I noticed after the installation was that the sudo command wasn’t included by default. I had to install it manually and add the user to the sudo group using:

su
apt update
apt install sudo
usermod -aG sudo

Setup Using ha-chromium-kiosk-setup.sh:

1. Downloading the Script
wget https://raw.githubusercontent.com/kunaalm/HA-Chromium-Kiosk/refs/heads/main/ha-chromium-kiosk-setup.sh
2. Running the Script

Once the script was downloaded, I gave it executable permissions and ran it. This is how I did it:

chmod +x ha-chromium-kiosk-setup.sh
./ha-chromium-kiosk-setup.sh
3. Configuration Prompts:

The script is designed to be interactive and need the following:

Conclusion

Setting up a touchscreen device to run a Home Assistant dashboard using Chromium in kiosk mode on Debian turned out to be a great solution for my smart home setup. The script I have written automates most of the setup and removal, including the kiosk mode configuration and mouse pointer removal.

You can find the script and detailed documentation on GitHub: HA-Chromium-Kiosk.