Skip to content

Commit

Permalink
docs: document new features
Browse files Browse the repository at this point in the history
  • Loading branch information
@jcwillox
jcwillox committed Aug 11, 2022
1 parent 198fa29 commit 33e2b9a
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
7 changes: 6 additions & 1 deletion docs/home-assistant-core.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,10 @@

To use Auto Backup on Home Assistant Core you will need to have the [`backup`](https://www.home-assistant.io/integrations/backup) integration loaded, if you are already using [`default_config`](https://www.home-assistant.io/integrations/default_config) (enabled by default) then this will already be loaded.

!!! note
Currently, you cannot configure the backup `password`, this may change in the future, but is due to the built-in backup integration not providing this option. Additionally, the `addons` and `folders` options are irrelevant for Home Assistant Core users.

!!! warning
Currently, you cannot configure the backup `name` or `password`, this may change in the future, but is due to the built-in backup integration not providing these options. Additionally, the `addons` and `folders` options are irrelevant for Home Assistant Core users.
Currently, the `name` option is not natively supported on Home Assistant Core. Auto Backup, however, provides a patch that enables this functionality through its service calls.

The patch is only temporarily enabled when attempting to create a backup with a custom name, if you do not specify the `name` field for any of Auto Backup's services the patch wont be applied. This is an experimental feature, and while the implementation is fairly robust if you experience any issues you can stop using the `name` field and [report an issue](https://github.com/jcwillox/hass-auto-backup/issues/new/choose) on GitHub.
22 changes: 11 additions & 11 deletions docs/services.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ Create a full or partial backup.

This is the primary method and includes the functionality of the `backup_full` and `backup_partial` services.

| Parameter | Description | Type | Example |
| -------------------------------------------- | --------------------------------------------------------- | -------- | ----------------------------------------------------------- |
| `name` | Optional name, defaults to the current date and time. | `string` | `#!jinja Automatic Backup {{ now().strftime('%Y-%m-%d') }}` |
| [`include_addons`](#addon-and-folder-names) | List of addons to include in the backup (name or slug). | `list` | `#!json ["Almond", "glances", "core_mariadb"]` |
| [`include_folders`](#addon-and-folder-names) | List of folders to include in the backup. | `list` | `#!json ["Local add-ons", "homeassistant", "share"]` |
| [`exclude_addons`](#addon-and-folder-names) | List of addons to exclude from the backup (name or slug). | `list` | `#!json ["Almond", "glances", "core_mariadb"]` |
| [`exclude_folders`](#addon-and-folder-names) | List of folders to exclude from the backup. | `list` | `#!json ["Local add-ons", "homeassistant", "share"]` |
| `password` | Optional password to secure backup. | `string` | `#!json 1234` |
| [`keep_days`](#keep-days) | The number of days to keep the backup. | `float` | `#!json 2` |
| [`download_path`](#download-path) | Locations to download the backup to after creation. | `list` | `#!json ["/usb_drive"]` |
| Parameter | Description | Type | Example |
| -------------------------------------------- | ----------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------- |
| `name` | Optional name, defaults to the current date and time. | `string` | `#!jinja Automatic Backup {{ now().strftime('%Y-%m-%d') }}` |
| [`include_addons`](#addon-and-folder-names) | List of addons to include in the backup (name or slug). Wildcards supported for slugs. | `list` | `#!json ["Almond", "glances", "core_mariadb", "core_*"]` |
| [`include_folders`](#addon-and-folder-names) | List of folders to include in the backup. | `list` | `#!json ["Local add-ons", "homeassistant", "share"]` |
| [`exclude_addons`](#addon-and-folder-names) | List of addons to exclude from the backup (name or slug). Wildcards supported for slugs. | `list` | `#!json ["Almond", "glances", "core_mariadb", "core_*"]` |
| [`exclude_folders`](#addon-and-folder-names) | List of folders to exclude from the backup. | `list` | `#!json ["Local add-ons", "homeassistant", "share"]` |
| `password` | Optional password to secure backup. | `string` | `#!json 1234` |
| [`keep_days`](#keep-days) | The number of days to keep the backup. | `float` | `#!json 2` |
| [`download_path`](#download-path) | Locations to download the backup to after creation. | `list` | `#!json ["/usb_drive"]` |

??? example "Create a full backup"

Expand Down Expand Up @@ -66,7 +66,7 @@ This is the primary method and includes the functionality of the `backup_full` a

### Addon and folder names

**Addon names** are case-insensitive and can be the addon name/title, these are the same names seen when creating a partial backup through the Supervisor backups page. They can also be the addons slug (slug must be lowercase).
**Addon names** are case-insensitive and can be the addon name/title, these are the same names seen when creating a partial backup through the Supervisor backups page. They can also be the addons slug (slug must be lowercase). You can also use wildcards for matching slugs, such as `core_*` to include all core addons.

**Folder names** are also case-insensitive and use the names seen when creating a partial backup through the Supervisor backups page.
Currently, accepted values are (ignoring case):
Expand Down

0 comments on commit 33e2b9a

Please sign in to comment.