Giter Club home page Giter Club logo

homebridge-raspbian-image's Introduction

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) and hardware decoding (h264_omx)
  • 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, deCONZ, Node-RED and the UniFI Controller.

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

Download

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

Flash to SD Card

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

  1. Download and install the latest version of Etcher.
  2. Open Etcher and select the Homebridge-Raspbian-v0.0.0.zip file you have downloaded. There is no need to extract the .zip file first.
  3. Choose the drive your SD card has been inserted into.
  4. Click Flash.

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 Config UI X 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.

The default user is admin with password admin.

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

You should take a moment to review the Configuration Reference at the bottom of this guide.

Updating Node.js

To update Node.js run sudo hb-config and select Upgrade Node.js.

This will ensure your Raspberry Pi is running the latest LTS version of Node.js.

hb-config

SSH Access

SSH is enabled by default. The default username is pi with password raspberry.

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

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.

File Location / Command
Config File Path /var/lib/homebridge/config.json
Storage Path /var/lib/homebridge
Restart Command sudo hb-service restart
Stop Command sudo hb-service stop
Start Command sudo hb-service start
View Logs Command sudo hb-service logs
Manage Homebridge Server sudo hb-config
Systemd Service File /etc/systemd/system/homebridge.service
Systemd Env File /etc/default/homebridge
Default Hostname homebridge.local
Default SSH Username pi
Default SSH Password raspberry
Default Web Username admin
Default Web Password admin

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

homebridge-raspbian-image's People

Contributors

andig avatar andrewmichaelsmith avatar bjpirt avatar bjsowa avatar cfstras avatar chrisdecker1201 avatar davesteele avatar dcwangmit01 avatar gadgetoid avatar gszy avatar hhromic avatar jacen92 avatar jamesruan avatar knghtbrd avatar lcvandinteren avatar louismt avatar luigifcruz avatar m-roberts avatar martignoni avatar matthijskooijman avatar oskar456 avatar oznu avatar reneklootwijk avatar rickdoesdev avatar rkubes avatar rnestler avatar sam3d avatar samtygier avatar tjstyle avatar xecdesign avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.