Repository files navigation

This project provides a freeRaspbian based Raspberry Pi image withHomebridge andHomebridge Config UI X pre-installed.

• Runs on RPI 2 or higher models supporting ARMv7 cpu's or greater ( Last version supporting RPI 1 and RPi Zero W wasv1.2.4)
• Built on Raspbian Lite (no desktop)
• Simple WiFi Setup
• Includesffmpeg pre-compiled with audio support (libfdk-aac)
• Includes a user friendly, easy to use web based GUI to configure Homebridge and monitor your Raspberry Pi
• Visual configuration for over 400 plugins (no manual config.json editing required)

This image also provides a command calledhb-config which helps you keep Node.js up-to-date, perform maintenance on your Homebridge server, and install additional optional software such asPi Hole anddeCONZ.

The Homebridge service is installed using the method described in the officialRaspberry Pi Installation Guide on theHomebridge project wiki.

Note: The homebridge Image is temporarily not available for download within the Raspberry PI Imager Tool.

As a workaround, please download latest image fromhere, and use the 'Custom' option under 'Choose OS' within the imager tool.

TheHomebridge Raspberry Pi Image is completely free (no sign up required).

The easiest way to flash theHomebridge Raspberry Pi Image to your SD card is to use theRaspberry Pi Imager.

1. Download and install the latest version ofRaspberry Pi Imager.
2. Open theRaspberry Pi Imager application.
3. ClickChoose Device
4. Scroll down and select theNo filtering option.
5. ClickChoose OS.
6. Scroll down and select theOther specific purpose OS category.
7. Select theHome assistants and home automation category.
8. SelectHomebridge, then choose your Homebridge image.

• 32bit - For all RPI Models
• 64bit - For RPI 3B, 3B+, 3A+, 4B, 400, 5, CM3, CM3+, CM4, CM4S, Zero 2 W

9. ClickChoose Storage and select your SD card.
10. ClickNext
11. ForUse OS Customisation, selectNo
12. ClickWrite

Raspberry Pi Imager will now download and flash the latest version of theHomebridge Raspberry Pi Image to your SD card, this may take several minutes depending on the speed of your internet connection and SD card.

Advanced users:

If you wish to use another tool such asEtcher ordd to flash the Homebridge Raspberry Pi Image, you can manually download the image from our releases page:

Now that you have flashed your SD card, you can insert it into your Raspberry Pi.

Before powering on your Raspberry Pi decide if you want to use Ethernet or WiFi to connect to your network.

⚠️ An Ethernet connection is recommended as this provides the most simple and stable Homebridge setup.

If you have decided to connect your Raspberry Pi using ethernet, do so before you power on your device for the first time.

Follow these steps to connect your device to WiFi:

1. Power on your device without an Ethernet cable attached.
2. Wait 1-2 minutes
3. Use your mobile phone to scan for new WiFi networks
4. Connect to the hotspot namedHomebridge WiFi Setup
5. Wait a few moments until the captive portal opens, this portal will allow you to connect the Raspberry Pi to your local WiFi network.

If you enter your WiFi credentials incorrectly theHomebridge WiFi Setup hotspot will reappear allowing you to try again.

TheHomebridge 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.

If you're using macOS or a mobile device, you should be able to access the UI viahttp://homebridge.local.

If you're using Windows, orhttp://homebridge.local does not work for you, you will need to find the IP address of your Raspberry Pi another way:

1. Login to your router and find the "connected devices" or "dhcp clients" page to find the IP address that was assigned to the Raspberry Pi.
2. Use an iPhone to accesshttp://homebridge.local, once you login using the default username and password (admin/admin) you can find the IP address under System Information.
3. Download theFing app foriOS orAndroid to scan your network to find the IP address of your Raspberry Pi.
4. As a last resort, if you plug a monitor into your Raspberry Pi, the IP address will be displayed on the attached screen once it has finished booting.

Once you've found your IP address, login to the web interface by going tohttp://<ip address of your server>.

• Privacy: TheHomebridge Raspbian Image, as well as theHomebridge andHomebridge Config UI X software components, do not contain anyanalytics,call home, or similar features that would allow the project maintainers to track you or the usage of this image.
• Security: TheHomebridge Raspbian Image is kept up-to-date with the latestofficial Raspbian builds. To find out more, or to report a security issue or vulnerability, please see the project'sSECURITY policy.
• Transparency: TheHomebridge Raspbian Image project is open source and each image is built using the public GitHub Action runners. The build logs for each release are publicly available on the project'sGitHub Actions page and every release contains a SHA-256 checksum of the image you can use to verify the integrity of your download.

The official Homebridge Discord server and Reddit community are where users can discuss Homebridge and ask for help.

TheHomebridge Raspberry Pi Image wiki contains more information and instructions on how to further customise your install:

https://github.com/homebridge/homebridge-raspbian-image/wiki