{"id":13585965,"url":"https://github.com/jcwillox/hass-auto-backup","last_synced_at":"2026-05-11T07:57:30.298Z","repository":{"id":40576019,"uuid":"221855213","full_name":"jcwillox/hass-auto-backup","owner":"jcwillox","description":"🗃️ Improved Backup Service for Home Assistant that can Automatically Remove Backups and Supports Generational Backup Schemes.","archived":false,"fork":false,"pushed_at":"2025-02-08T14:53:36.000Z","size":1159,"stargazers_count":428,"open_issues_count":25,"forks_count":27,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-08T08:11:17.402Z","etag":null,"topics":["auto-purge","backups","generational-backups","hassio","homeassistant","snapshots"],"latest_commit_sha":null,"homepage":"https://jcwillox.github.io/hass-auto-backup","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jcwillox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"jcwillox"}},"created_at":"2019-11-15T06:03:46.000Z","updated_at":"2025-04-03T14:52:23.000Z","dependencies_parsed_at":"2024-05-19T05:25:06.374Z","dependency_job_id":"457d73f9-3149-49af-ac95-ad102e14f8a6","html_url":"https://github.com/jcwillox/hass-auto-backup","commit_stats":{"total_commits":180,"total_committers":16,"mean_commits":11.25,"dds":"0.10555555555555551","last_synced_commit":"413dfe666f18d4c7dec28823bf95448618d44317"},"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcwillox%2Fhass-auto-backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcwillox%2Fhass-auto-backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcwillox%2Fhass-auto-backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcwillox%2Fhass-auto-backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcwillox","download_url":"https://codeload.github.com/jcwillox/hass-auto-backup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254422755,"owners_count":22068678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["auto-purge","backups","generational-backups","hassio","homeassistant","snapshots"],"created_at":"2024-08-01T15:05:15.011Z","updated_at":"2026-05-11T07:57:25.276Z","avatar_url":"https://github.com/jcwillox.png","language":"Python","funding_links":["https://ko-fi.com/jcwillox"],"categories":["Python","Custom Integrations"],"sub_categories":["🛠️ Automation tooling"],"readme":"# 🗃️ Auto Backup\n\n[![HACS Badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)\n[![License](https://img.shields.io/github/license/jcwillox/hass-auto-backup?style=for-the-badge)](https://github.com/jcwillox/hass-auto-backup/blob/main/LICENSE)\n[![Latest Release](https://img.shields.io/github/v/release/jcwillox/hass-auto-backup?style=for-the-badge)](https://github.com/jcwillox/hass-auto-backup/releases)\n[![Size](https://img.badgesize.io/https:/github.com/jcwillox/hass-auto-backup/releases/latest/download/auto_backup.zip?style=for-the-badge)](https://github.com/jcwillox/hass-auto-backup/releases)\n[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black)\n[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=jcwillox\u0026repository=hass-auto-backup\u0026category=integration)\n[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=auto_backup)\n\nAuto Backup is an Improved Backup Service for Home Assistant that can Automatically Remove Backups and Supports Generational Backup Schemes.\n\n\u003e While Home Assistant does provide built-in services for creating backups, they do not provide the ability to exclude items from a backup, or a way to automatically remove them, this custom component aims to fix that.\n\nFor more information and examples check the [documentation](https://jcwillox.github.io/hass-auto-backup).\n\n## Features\n\n- Provides more advanced and configurable [service calls](https://jcwillox.github.io/hass-auto-backup/services).\n- [Exclude addons/folders](https://jcwillox.github.io/hass-auto-backup/services) from a backup.\n- [Automatically delete backups](https://jcwillox.github.io/hass-auto-backup/services/#keep-days) after an individually specified amount of time.\n- Backup to [custom locations](https://jcwillox.github.io/hass-auto-backup/services/#custom-locations) such as network storage.\n- [Download backups](https://jcwillox.github.io/hass-auto-backup/services/#download-path) to a specified directory after completion (for example a usb drive).\n- Allows the use of [addon names instead of slugs](https://jcwillox.github.io/hass-auto-backup/services/#addon-and-folder-names).\n- Provides a [sensor](https://jcwillox.github.io/hass-auto-backup/sensors) to monitor the status of your backups.\n- Creates [events](https://jcwillox.github.io/hass-auto-backup/events) for when backups are started/created/failed/deleted.\n- Supports [generational backup](https://jcwillox.github.io/hass-auto-backup/advanced-examples/#generational-backups) schemes.\n\n## Services\n\n[Automation Examples using Services](https://jcwillox.github.io/hass-auto-backup/examples)\n\n- [`auto_backup.backup`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup)\n- [`auto_backup.backup_full`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup_full)\n- [`auto_backup.backup_partial`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup_partial)\n- [`auto_backup.purge`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup_purge)\n\n## Events\n\n[Automation Example using Events](https://jcwillox.github.io/hass-auto-backup/events/#example-automation-using-events)\n\n- [`auto_backup.backup_start`](https://jcwillox.github.io/hass-auto-backup/events)\n- [`auto_backup.backup_successful`](https://jcwillox.github.io/hass-auto-backup/events)\n- [`auto_backup.backup_failed`](https://jcwillox.github.io/hass-auto-backup/events)\n- [`auto_backup.purged_backups`](https://jcwillox.github.io/hass-auto-backup/events)\n\n## Configuration\n\nAfter installing Auto Backup via [HACS](https://hacs.xyz/), it can then be setup via the UI, by going to **Configuration** → **Devices \u0026 Services** → **Add Integration** → **Auto Backup** or by clicking the button below.\n\n[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=auto_backup)\n\n### Options\n\n- **Automatically delete expired backups**\n\n  - This option will automatically purge any expired backups when creating a new backup.\n\n- **Backup Timeout**\n  - You can increase this value if you get timeout errors when creating a backup. This can happen with very large backups. Increasing this might make Auto Backup less reliable at monitoring backups to delete.\n\n## Images\n\n\u003cimg alt=\"Sensor Example\" src=\"docs/assets/example-sensor.png\" width=\"400px\"\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcwillox%2Fhass-auto-backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcwillox%2Fhass-auto-backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcwillox%2Fhass-auto-backup/lists"}