• Stars
    star
    1,004
  • Rank 45,731 (Top 1.0 %)
  • Language
    Shell
  • License
    BSD 3-Clause "New...
  • Created almost 5 years ago
  • Updated 11 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Official Homebridge Raspberry Pi Image based on Raspberry Pi OS Lite.

Homebridge Raspberry Pi Image

Build GitHub release (latest by date) GitHub All Releases

This project provides a free Raspbian based Raspberry Pi image with Homebridge and Homebridge Config UI X pre-installed.

  • Works on all Raspberry Pi models
  • Built on Raspbian Lite (no desktop)
  • Simple WiFi Setup
  • Includes ffmpeg 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 called hb-config which helps you keep Node.js up-to-date, perform maintenance on your Homebridge server, and install additional optional software such as Pi Hole and deCONZ.

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

Download and Flash to SD Card

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

The easiest way to flash the Homebridge Raspberry Pi Image to your SD card is to use the Raspberry Pi Imager.

  1. Download and install the latest version of Raspberry Pi Imager.
  2. Open the Raspberry Pi Imager application.
  3. Click Choose OS.
  4. Scroll down and select the Other specific purpose OS category.
  5. Select the Home assistants and home automation category.
  6. Select Homebridge, then choose the latest Homebridge image.
  7. Click Choose Storage and select your SD card.
  8. Click Write.

Raspberry Pi Imager will now download and flash the latest version of the Homebridge 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 as Etcher or dd to flash the Homebridge Raspberry Pi Image, you can manually download the image from our releases page:

Download Latest Version

First Boot / Network Setup

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.

Ethernet

⚠️ 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.

WiFi Setup

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 named Homebridge 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 the Homebridge WiFi Setup hotspot will reappear allowing you to try again.

wifi-connect-setup

Managing Homebridge

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.

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

If you're using Windows, or http://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 access http://homebridge.local, once you login using the default username and password (admin/admin) you can find the IP address under System Information.
  3. Download the Fing app for iOS or Android 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 to http://<ip address of your server>.

Security and Privacy

  • Privacy: The Homebridge Raspbian Image, as well as the Homebridge and Homebridge Config UI X software components, do not contain any analytics, call home, or similar features that would allow the project maintainers to track you or the usage of this image.
  • Security: The Homebridge Raspbian Image is kept up-to-date with the latest official Raspbian builds. To find out more, or to report a security issue or vulnerability, please see the project's SECURITY policy.
  • Transparency: The Homebridge 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's GitHub Actions page and every release contains a SHA-256 checksum of the image you can use to verify the integrity of your download.

Community

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

Homebridge Discord Homebridge Reddit

Help

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

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

More Repositories

1

homebridge

HomeKit support for the impatient.
TypeScript
22,843
star
2

HAP-NodeJS

Node.js implementation of the HomeKit Accessory Protocol (HAP)
TypeScript
2,685
star
3

homebridge-config-ui-x

The Homebridge UI. Monitor, configure and backup Homebridge from a browser.
TypeScript
2,614
star
4

docker-homebridge

Homebridge Docker. HomeKit support for the impatient using Docker on x86_64, Raspberry Pi (armhf) and ARM64. Includes ffmpeg + libfdk-aac.
Shell
2,577
star
5

homebridge-syno-spk

Homebridge Package for Synology DSM 7.
Shell
606
star
6

verified

Plugins Verified by Homebridge
TypeScript
348
star
7

homebridge-plugin-template

A template you can use to create your own Homebridge plugins.
TypeScript
279
star
8

ffmpeg-for-homebridge

Static FFmpeg binaries for Homebridge with support for audio (libfdk-aac) and hardware-accelerated decoding and encoding (h264_qsv, h264_v4l2m2m, videotoolbox).
Shell
108
star
9

ciao

RFC 6762 and RFC 6763 compliant mdns service discovery library written in Typescript
TypeScript
77
star
10

homebridge-examples

Collection of homebridge plugin examples
TypeScript
77
star
11

plugin-ui-utils

Create fully customisable configuration user interfaces for Homebridge plugins.
TypeScript
29
star
12

homebridge-apt-pkg

Debian / Ubuntu package and repo for Homebridge
Shell
21
star
13

camera-utils

Utilities to simplify homebridge camera plugin development
TypeScript
18
star
14

homebridge.io

The https://homebridge.io website.
HTML
10
star
15

homebridge.github.io

Homebridge Plugin Development Documentation Website.
SCSS
10
star
16

HAP-NodeJS-examples

Collection of examples to get started using HAP-NodeJS as a library.
TypeScript
9
star
17

.github

Global workflow files and community health files for the Homebridge organization.
8
star
18

documentation

Placeholder repository for the Homebridge plugin development docs.
JavaScript
7
star
19

homebridge-macos-pkg

Work in progress. Homebridge macOS Installer.
Shell
7
star
20

branding

Homebridge branding guidelines, naming conventions, logo usage rules, and logo files.
7
star
21

hap-client

A client for an insecure HAP-NodeJS instance
TypeScript
6
star
22

mdns-diagnostics

Test tool to display HAP instances on your network
JavaScript
4
star
23

homebridge-plugin-camera-template

A template you can use to create your own Homebridge camera plugins.
TypeScript
2
star
24

plugin-repo

Bundles for Verified Homebridge Plugins
TypeScript
2
star