Home Assistant Add on

Home Assistant Add-on

The Printbuddy Home Assistant add-on runs the full Printbuddy application inside Home Assistant.

Repository: vmhomelab/printbuddy-ha-addon

When to use the add-on

Use the add-on if you want Home Assistant to host Printbuddy directly and open it from the Home Assistant sidebar or Open Web UI button.

The add-on is useful when:

• Home Assistant is already your central dashboard.
• You want Home Assistant Ingress access instead of a separate reverse proxy.
• Printbuddy should run with persistent Home Assistant add-on storage.
• Your printers are reachable from the Home Assistant host network.

Installation

1. In Home Assistant, open Settings → Add-ons → Add-on Store.

2. Open the ⋮ menu and choose Repositories.

3. Add this repository URL:

   https://github.com/vmhomelab/printbuddy-ha-addon
   

4. Install Printbuddy.

5. Start the add-on.

6. Open Printbuddy through Open Web UI or the sidebar panel.

Networking and storage

The add-on uses Home Assistant Ingress for the web UI/API and host networking for printer-facing communication.

Relevant ports:

• 8000/tcp: Printbuddy web UI/API, normally accessed through Ingress.
• 322/tcp: Virtual printer FTP/control compatibility.
• 990/tcp: FTPS compatibility.
• 8883/tcp: MQTT over TLS compatibility.
• 3000/tcp, 3002/tcp: optional auxiliary Printbuddy feature ports.

Persistent data is stored in the add-on data volume:

• /data/printbuddy: Printbuddy data, database, and archive storage.
• /data/logs: Printbuddy logs.

Development status

The add-on is still under active development. Test new work from the add-on repository's dev branch first, then publish approved changes to main so Home Assistant can see the stable metadata.

See also: Home Assistant Integration