Skip to content

Commit

Permalink
docs: update services with new options
Browse files Browse the repository at this point in the history
  • Loading branch information
jcwillox committed Jul 29, 2023
1 parent 6354f9f commit 07cbcff
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 61 deletions.
6 changes: 5 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,9 @@
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter"
},
"yaml.customTags": ["!env"]
"yaml.customTags": [
"!ENV",
"tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
"tag:yaml.org,2002:python/name:materialx.emoji.to_svg"
]
}
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,33 @@ Auto Backup is an Improved Backup Service for Home Assistant that can Automatica
For more information and examples check the [documentation](https://jcwillox.github.io/hass-auto-backup).

## Features
* Provides more advanced and configurable [service calls](https://jcwillox.github.io/hass-auto-backup/services).
* [Exclude addons/folders](https://jcwillox.github.io/hass-auto-backup/services) from a backup.
* [Automatically delete backups](https://jcwillox.github.io/hass-auto-backup/services/#keep-days) after an individually specified amount of time.
* [Download backups](https://jcwillox.github.io/hass-auto-backup/services/#download-path) to a specified directory after completion (for example a usb drive).
* Allows the use of [addon names instead of slugs](https://jcwillox.github.io/hass-auto-backup/services/#addon-and-folder-names).
* Provides a [sensor](https://jcwillox.github.io/hass-auto-backup/sensors) to monitor the status of your backups.
* Creates [events](https://jcwillox.github.io/hass-auto-backup/events) for when backups are started/created/failed/deleted.
* Supports [generational backup](https://jcwillox.github.io/hass-auto-backup/advanced-examples/#generational-backups) schemes.

- Provides more advanced and configurable [service calls](https://jcwillox.github.io/hass-auto-backup/services).
- [Exclude addons/folders](https://jcwillox.github.io/hass-auto-backup/services) from a backup.
- [Automatically delete backups](https://jcwillox.github.io/hass-auto-backup/services/#keep-days) after an individually specified amount of time.
- Backup to [custom locations](https://jcwillox.github.io/hass-auto-backup/services/#custom-locations) such as network storage.
- Allows the use of [addon names instead of slugs](https://jcwillox.github.io/hass-auto-backup/services/#addon-and-folder-names).
- Provides a [sensor](https://jcwillox.github.io/hass-auto-backup/sensors) to monitor the status of your backups.
- Creates [events](https://jcwillox.github.io/hass-auto-backup/events) for when backups are started/created/failed/deleted.
- Supports [generational backup](https://jcwillox.github.io/hass-auto-backup/advanced-examples/#generational-backups) schemes.

## Services

[Automation Examples using Services](https://jcwillox.github.io/hass-auto-backup/examples)

* [`auto_backup.backup`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup)
* [`auto_backup.backup_full`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup_full)
* [`auto_backup.backup_partial`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup_partial)
* [`auto_backup.purge`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup_purge)
- [`auto_backup.backup`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup)
- [`auto_backup.backup_full`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup_full)
- [`auto_backup.backup_partial`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup_partial)
- [`auto_backup.purge`](https://jcwillox.github.io/hass-auto-backup/services/#auto_backupbackup_purge)

## Events

[Automation Example using Events](https://jcwillox.github.io/hass-auto-backup/events/#example-automation-using-events)

* [`auto_backup.backup_start`](https://jcwillox.github.io/hass-auto-backup/events)
* [`auto_backup.backup_successful`](https://jcwillox.github.io/hass-auto-backup/events)
* [`auto_backup.backup_failed`](https://jcwillox.github.io/hass-auto-backup/events)
* [`auto_backup.purged_backups`](https://jcwillox.github.io/hass-auto-backup/events)
- [`auto_backup.backup_start`](https://jcwillox.github.io/hass-auto-backup/events)
- [`auto_backup.backup_successful`](https://jcwillox.github.io/hass-auto-backup/events)
- [`auto_backup.backup_failed`](https://jcwillox.github.io/hass-auto-backup/events)
- [`auto_backup.purged_backups`](https://jcwillox.github.io/hass-auto-backup/events)

## Configuration

Expand All @@ -51,6 +52,7 @@ After installing Auto Backup via [HACS](https://hacs.xyz/), it can then be setup
### Options

- **Automatically delete expired backups**

- This option will automatically purge any expired backups when creating a new backup.

- **Backup Timeout**
Expand Down
17 changes: 9 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,19 @@ Auto Backup is an Improved Backup Service for Home Assistant that can Automatica
[![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&repository=hass-auto-backup&category=integration)

!!! important ""

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.

## Features

* [x] Provides more advanced and configurable [service calls](services.md).
* [x] [Exclude addons/folders](services.md) from a backup.
* [x] [Automatically delete backups](services.md#keep-days) after an individually specified amount of time.
* [x] [Download backups](services.md#download-path) to a specified directory after completion (for example a usb drive).
* [x] Allows the use of [addon names instead of slugs](services.md#addon-and-folder-names).
* [x] Provides a [sensor](sensors.md) to monitor the status of your backups.
* [x] Creates [events](events.md) for when backups are started/created/failed/deleted.
* [x] Supports [generational backup](advanced-examples.md#generational-backups) schemes.
- [x] Provides more advanced and configurable [service calls](services.md).
- [x] [Exclude addons/folders](services.md) from a backup.
- [x] [Automatically delete backups](services.md#keep-days) after an individually specified amount of time.
- [x] Backup to [custom locations](services.md#custom-locations) such as network storage.
- [x] Allows the use of [addon names instead of slugs](services.md#addon-and-folder-names).
- [x] Provides a [sensor](sensors.md) to monitor the status of your backups.
- [x] Creates [events](events.md) for when backups are started/created/failed/deleted.
- [x] Supports [generational backup](advanced-examples.md#generational-backups) schemes.

## Configuration

Expand Down
Loading

0 comments on commit 07cbcff

Please sign in to comment.