← Install

Installing Franzl Gateway on Home Assistant

From the App Store to a running gateway in just a few minutes. A computer is the comfiest way to do this part; the pairing happens on your phone.

Requirement: A running Home Assistant installation with the App Store (Home Assistant OS or Supervised, version 2024.1+). If you don't have that yet: starter path or requirements.

Still called "Add-ons" on your system? Home Assistant renamed these programs to Apps in version 2026.2. On older versions you'll find the same entries under Settings → Add-ons and Add-on Store — the path is identical, only the label differs.

1. Add the app repository

The easiest way is with one click: this button opens your own Home Assistant and adds the Franzl repository:

Without the button, you can do it manually: in Home Assistant go to Settings → Apps → App Store, then the three-dot menu ⋮ → Repositories in the top right, and paste this address:

https://github.com/franzdinhobl/franzl-addons

2. Install & start

In the App Store, select "Franzl Gateway" and tap Install. A ready-made image is downloaded, no compiling, no terminal. After that:

1. Tap Start. The first start can take a minute (the built-in database is being set up).
2. Enable "Start on boot" and "Watchdog": that way Franzl comes back up on its own after a power outage.

3. Open the app: Franzl does the rest

Now pick up your phone — on the same Wi-Fi as your Home Assistant — and open the Franzl app. It looks for the freshly started gateway on your home network and picks up the activation code straight from it. In the vast majority of cases, all you do is tap Activate.

So normally there's nothing to type. If your network doesn't pass such searches along, the code works just as well: open the Franzl Gateway's interface (the "Open Web UI" tab, or the Franzl entry in the sidebar). There you'll find your 9-character activation code (uppercase letters and digits, e.g. A1B2C3D4E) and a QR code to scan.

Next: connect the app — the full sequence with all three ways is over there.

Not working? Check that the Franzl Gateway is actually running (green status) and that your Home Assistant has internet access (for downloading the image). Otherwise: Help section, the most common snags are listed there with solutions.