Backup and Restore
This article will explain how to backup and restore your Homebridge instance.
A Homebridge backup generated using the Homebridge UI contains the entire contents of your Homebridge storage directory, which includes your Homebridge config, cached accessories, HomeKit pairings, plugin information, and Homebridge UI user accounts.
The backups can be used to rollback your existing system, or migrate to a new server.
Backup archives are cross-platform compatible, for example, a backup archive generated on Homebridge running on Windows 10 can be restored to Homebridge running on a Raspberry Pi, or vice versa.
- Login to the Homebridge UI and from the drop down menu in the upper-right-corner select Backup / Restore.
- Clicking the Download Backup Archive button
This will generate and download a .tar.gz file containing the entire contents of your Homebridge storage folder, including your config.json, a list of installed plugins, cached accessories, and HomeKit pairing information.
You can restore a previously generated backup archive using the Homebridge UI.
- Ensure you have setup Homebridge using one the methods described in the Homebridge wiki.
- Login to the Homebridge UI and from the drop down menu in the upper-right-corner select Backup / Restore.
- Click Browse and select the backup archive you previously generated.
- Click Restore Backup.
Your Homebridge backup will now be restored and any missing plugins will be installed. Once the operation has completed click Restart Homebridge.
In some cases, after doing a restore, you may need to Reset Homebridge and re-add the bridge in the Home app.
To make a backup without the Homebridge UI, you can archive or make a copy of the Homebridge storage directory (the one that contains your config.json file). To restore, just extract or copy the contents back to the Homebridge storage directory. You will need to manually reinstall any plugins.