Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Terminus Server (BYOS) for Home Assistant
This is a Home Assistant add-on that runs a TRMNL Terminus Server on your instance to enable self-hosted local management of TRMNL devices (BYOS). The server is exposed to port 2300 by default.
Installation
Home Assistant OS (Recommended)
-
Add this repository to Home Assistant:
- Go to Settings → Add-ons → Add-on Store → ⋮ → Repositories
- Add:
https://github.com/usetrmnl/trmnl-home-assistant
-
Install the Terminus Server (BYOS) add-on
-
Add your Home Assistant instance's information to the add-on's configuration
-
Start the add-on and open the Web UI
Security
Important: This add-on is designed for trusted home networks. While Terminus itself has authentication features, this add-on wrapper does not provide any special security features when it comes to port or database credential accesses.
The container is confined by an AppArmor profile that denies it access to Home Assistant's /config, /ssl, /backup, /share and /media directories, to other add-ons, and to raw sockets.
License
Copyright (c) 2026 TRMNL
Licensed under the Apache License 2.0
