Home Assistant backup manager, both locally and on network storage.
This package allows you to manage the backup of Home Assistant. You can schedule full or partial backups, either alternatively or concurrently. For example, you can schedule a full backup once a week and a backup of Home Assistant istance only once a day.
The partial backup manager allows you to choose which elements to include in the backup, such as add-ons and system folders. The backup process is monitored, and you can receive system notifications and Pushover notifications indicating the successful completion or failure of the backup.
In addition to managing the settings and automatically creating backups, you can also decide how many backups to keep, giving you control over the total size of the backup archive. This package also provides information about the latest available backup, such as its name, date, and type.
The backup is created in the default location set in Home Assistant, which means it can be done locally, as the default setting, or on network storage, a feature available from Home Assistant version 2023.6
- Supervisor: See Home Assistant official page
- Pakages: See Home Assistant Package integration page
- PushOver notification service: See the Home Assistant Pushover intagation page
- Shell Access, for example with SSHCommand Add-On available trought HACS See the GitHUB repository page
This package is composed of three elements:
- The package it self: pkg_backup_home_assistant.yaml
- A script: backup_remove.sh
- Configuration for the Home Assistant frontend: ha_backup_frontend.yaml
To install the package, you need to use the first two files, while the third one is prepared for management.
To proceed with the installation:
- Download the repository.
- Copy the file pkg_backup_home_assistant.yaml to the packages folder, for example, /config/packages.
- Copy the script backup_remove.sh to the configurations folder, /config.
- Make the script executable by accessing the Home Assistant CLI, for instance, through SSHCommand Add-On, and execute as the root user:
chmod +x backup_remove.sh
- Restart Home Assistant.
- Create a new card in the Home Assistant frontend and paste the content of the ha_backup_frontend.yaml file into it.
The backup is executed in the default destination folder of Home Assistant.
The basic setting involves local backup creation, but it's possible to move the storage externally to a remote destination connected via SMB or NFS. To do this, you need to configure the remote location in Settings > System > Storage.
In the configuration screen, select "Backup" as the use of storage and fill in the data for accessing the remote share. Once the settings are saved, the connection to the new backup destination will be established.
To verify that it has been set as the default one, go to Settings > System > Backups and from the three-dot menu in the upper right corner select "Change default backup location." Then, from the dropdown list, choose the location created with network storage
The card for the frontend is designed to be dynamic. The basic display shows:
- The health status of the backup.
- The name and date of the last backup.
- The option to manually execute a full/partial backup and delete old backups, as configured in the settings explained below.
By activating the "Show detailed backup information" selector, the card will expand, adding additional data about the last backup and displaying information about the complete backup archive, including the number of available backups and their total size.
The settings can be enabled using their respective selectors.
The "Full Backup Settings" selector displays settings related to the full backup of Home Assistant, including:
- A selector to enable the automation of the full backup.
- Scheduling settings, such as days and time.
- A timeout setting for the backup, which serves as a waiting period for the automated backup check to ensure its completion. It's essential to set an adequately long time to ensure that the backup has been created. In any case, the check will conclude correctly at the end of the actual backup creation duration.
The "Partial Backup Settings" selector shows settings related to the partial backup of Home Assistant, including:
- A selector to enable the automation of the partial backup.
- Scheduling settings, such as days and time.
- A selector for the backup timeout, as described above.
- Selectors to enable the components to include in the backup. By default, the backup includes Home Assistant, and you can add Add-Ons and system folders to the partial backup. Enabling all options will result in a partial backup equivalent to a full backup.
The "Retained Backup Settings" selector displays settings related to the removal of old backups of Home Assistant, ensuring that the overall size of the archive is controlled, including:
- A selector to enable the automation of old backup removal.
- A selector to specify the number of backups to keep, automatically deleting all older backups beyond this number.
I received support from the HassioHelp community in the development of this package, and I would like to express my gratitude to them.
- Version 1.0: Initial release
- Version 1.1: Modified persistent notifications in accordance with Home Assistant version 2024.6