Self-host Z-Wave JS UI with Levelrail

A control panel and MQTT gateway for Z-Wave networks that pairs with Home Assistant.

  • Authorzwave-js
  • LicenceMIT
  • Memory256 MiB
  • Services1

How to self-host Z-Wave JS UI

  1. Pull the images

    One image is pulled on your server.

    Show images
    • zwavejs/zwave-js-ui:11.26.2
  2. Create the app

    One service starts in a single Compose app, with 1 named volume mount for your data, on ports 8091, 3000.

  3. Fill in the secrets

    1 secret is generated and stored encrypted, 1 setting is preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

After the first start

  • Open the address and pick your Z-Wave serial adapter in Settings.

Z-Wave JS UI requirements

Memory
About 256 MiB
Architectures
amd64 unknown, arm64 unknown
Ports
8091, 3000
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
MIT, permissive license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Z-Wave JS UI. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Z-Wave JS UI docs page.

Deploy Z-Wave JS UI your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Z-Wave JS UI from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain zwave-js-ui=app.example.com.

levelrail-cli templates install zwave-js-ui --name my-zwave-js-ui

Deploy Z-Wave JS UI with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/zwave-js-ui/install \
  -d '{
    "name": "my-zwave-js-ui"
  }'

Z-Wave JS UI configuration

Z-Wave JS UI services

ServiceImagePortsVolumes
zwave-js-ui zwavejs/zwave-js-ui:11.26.2 8091, 3000 store -> /usr/src/app/store

Z-Wave JS UI environment variables

VariableServiceValue
SESSION_SECRET zwave-js-ui Generated at deploy
TZ zwave-js-ui Preset by the template

Ports and volumes

Ports
8091, 3000
Volumes
1 named mount: store -> /usr/src/app/store

Z-Wave JS UI FAQ

How much memory does Z-Wave JS UI need?

The catalog lists about 256 MiB of memory for Z-Wave JS UI.

Does Z-Wave JS UI run on arm64?

For Z-Wave JS UI, arm64 support is not confirmed; amd64 is unknown.

What licence is Z-Wave JS UI under?

Z-Wave JS UI is licensed under MIT, which is permissive, with few conditions on reuse.

Does Z-Wave JS UI need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which ports does Z-Wave JS UI use?

Z-Wave JS UI listens on ports 8091 and 3000 inside the stack.

Where does Z-Wave JS UI keep its data?

In a named volume: store mounted at /usr/src/app/store.

Can I deploy Z-Wave JS UI on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Z-Wave JS UI, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image zwavejs/zwave-js-ui:11.26.2 is what you deploy there.

levelrail-cli templates install zwave-js-ui --name my-zwave-js-ui