Skip to content

Commit 09d9756

Browse files
committed
docs: update features section and add blueprints list
1 parent 1f04841 commit 09d9756

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

docs/index.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,34 @@ Auto Backup is an Improved Backup Service for Home Assistant that can Automatica
66

77
!!! important ""
88

9-
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.
9+
While Home Assistant does provide built-in services for creating backups, they do not provide the ability to exclude items from a backup, or advanced retention settings, this custom integration aims to fix that. See the [FAQ](faq.md) for more information on differences.
1010

1111
## Features
1212

13-
- [x] Provides more advanced and configurable [service calls](services.md).
14-
- [x] [Exclude addons/folders](services.md) from a backup.
15-
- [x] [Automatically delete backups](services.md#keep-days) after an individually specified amount of time.
16-
- [x] Backup to [custom locations](services.md#custom-locations) such as network storage.
17-
- [x] [Download backups](services.md#download-path) to a specified directory after completion (for example a usb drive).
18-
- [x] Allows the use of [addon names instead of slugs](services.md#addon-and-folder-names).
19-
- [x] Provides a [sensor](sensors.md) to monitor the status of your backups.
20-
- [x] Creates [events](events.md) for when backups are started/created/failed/deleted.
21-
- [x] Supports [generational backup](advanced-examples.md#generational-backups) schemes.
13+
- [x] Provides more advanced and configurable [service calls](services.md).
14+
- [x] [Exclude addons/folders](services.md) from a backup.
15+
- [x] [Automatically delete backups](services.md#keep-days) after an individually specified amount of time.
16+
- [x] Backup to [custom locations](services.md#custom-locations) such as network storage.
17+
- [x] [Download backups](services.md#download-path) to a specified directory after completion (for example a usb drive).
18+
- [x] Allows the use of [addon names instead of slugs](services.md#addon-and-folder-names).
19+
- [x] Provides a [sensor](sensors.md) to monitor the status of your backups.
20+
- [x] Creates [events](events.md) for when backups are started/created/failed/deleted.
21+
- [x] Supports [generational backup](advanced-examples.md#generational-backups) schemes.
22+
- [x] Supports unencrypted and encrypted backups, including the default encryption added in 2025.1 see [#181](https://github.com/jcwillox/hass-auto-backup/issues/181).
23+
24+
## Blueprints
25+
26+
???+ blueprint "Blueprint: Automatic Backups"
27+
28+
Create backups each day and keep them for a configurable amount of time, backups are stored less frequently the older they are.
29+
30+
[![Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.](https://my.home-assistant.io/badges/blueprint_import.svg)](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A//raw.githubusercontent.com/jcwillox/home-assistant-blueprints/main/automation/automatic_backups.yaml)
31+
32+
???+ blueprint "Blueprint: Notifications"
33+
34+
Send notifications based on events created by the [Auto Backup](https://jcwillox.github.io/hass-auto-backup) integration, such as when a backup fails.
35+
36+
[![Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.](https://my.home-assistant.io/badges/blueprint_import.svg)](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A//raw.githubusercontent.com/jcwillox/home-assistant-blueprints/main/automation/notify_auto_backup.yaml)
2237

2338
## Configuration
2439

0 commit comments

Comments
 (0)