Homebridge on TrueNAS Scale

This guide provides step-by-step instructions to show you how to install Homebridge on TrueNAS Scale as a using Docker.

• Prerequisites
• Installing Homebridge
  • Step 1: Create Dataset for Homebridge
  • Step 2: Create Homebridge Docker Container
  • Complete: Login to the Homebridge UI
• Configuration Reference

Prerequisites

• TrueNAS Scale

Installing Homebridge

Step 1: Create Dataset for Homebridge

From the Storage section of the TrueNAS application, create a new dataset that will be used to store your Homebridge config and plugins.

Step 2: Disable mDNS on TrueNAS Scale Host

Under Network -> Global Settings -> Service Announcement uncheck the mDNS checkbox.

This is not ideal, if anyone has a workaround or alternative container networking methods that work, please let me know.

Step 3: Create Homebridge Docker Container

From the Apps section, select Launch Docker Image. Enter the details as follows:

1. Application Name: homebridge
2. Container Image:
   • Image repository: oznu/homebridge
   • Image tag: latest
3. Container Entrypoint: no changes
4. Container Environment Variables: no changes
5. Networking:
   • Provide access to node network namespace for the workload: check
6. Port Forwarding: no changes
7. Storage:
   • Configure Host Path Volumes
     • Host Path: path to the dataset created in step 1
     • Mount Path: /homebridge
8. Workload Details: no changes
9. Scaling/Upgrade Policy:
   • Update Strategy: Kill existing pods before creating new ones
10. Resource Reservation: no changes
11. Resource Limits: no changes
12. Portal Configuration: no changes
13. Confirm Options: Save

Complete: Login to the Homebridge UI

The container is now setup and ready for use and can be accessed on port 8581.

You can access the Homebridge UI using the IP address assigned to the container. You can click on the app and expand Application Events to find the IP address.

You can access the Homebridge UI using http://IP_ADDRESS:8581

The Homebridge UI web interface will allow you to install, remove and update plugins, and modify the Homebridge config.json and manage other aspects of your Homebridge service.

Configuration Reference

This table contains important information about your setup. You can use the information provided here as a reference when configuring or troubleshooting your environment after setting up Homebridge using the instructions below.

	File Location / Command
Config File Path	/homebridge/config.json (inside container)
Storage Path	/homebridge (inside container)
Plugin Path	/homebridge/node_modules (inside container)
Update Node CMD	hb-service update-node