Installation

Installation

Install through HACS

1. Open HACS in Home Assistant.
2. Add https://github.com/jl0906/BackupCheckup as a custom repository in the Integration category.
3. Install BackupCheckup.
4. Restart Home Assistant completely.
5. Open Settings → Devices & services → Add integration.
6. Search for BackupCheckup and complete the guided setup.

Direct HACS link:

Manual installation

1. Download the release archive.
2. Copy the complete custom_components/backup_checkup directory to /config/custom_components/backup_checkup.
3. Confirm that /config/custom_components/backup_checkup/manifest.json exists.
4. Restart Home Assistant.
5. Add BackupCheckup from Settings → Devices & services.

Always replace the complete integration directory during an update. Mixing files from different versions can cause a black panel, stale entities, or incompatible data models.

Optional sidebar panel

The sidebar is disabled by default. It can be enabled during setup or later in the BackupCheckup options. The integration remains fully usable without the panel through devices, entities, actions, Repairs, and the standard options dialog.

After enabling the panel or installing an update, a forced browser reload (Ctrl+F5) or a Companion App restart may be necessary because Home Assistant caches frontend modules.

Optional Runtime Runner

The Runtime Runner is not required. The regular integration can monitor, download, decrypt, and structurally verify backups without it.

The runner adds runtime evidence by starting the Home Assistant configuration from an already verified backup in a temporary, network-isolated environment. See Runtime-Runner for installation and safety details.

Verify the installation

At least these entities should be available after setup:

• sensor.backup_checkup_status
• sensor.backup_checkup_health_score
• sensor.backup_checkup_integrity_status
• sensor.backup_checkup_recovery_readiness
• binary_sensor.backup_checkup_problem
• button.backup_checkup_run_recovery_assessment
• button.backup_checkup_refresh

If entities are missing, open the BackupCheckup device and check the selected entity mode. See Troubleshooting for additional checks.