66 lines
4.4 KiB
YAML
66 lines
4.4 KiB
YAML
configuration:
|
|
recovery_mode:
|
|
name: Recovery mode
|
|
description: When this settings is toggled on, the add-on will not perform any backups and sync mode will reverse from OneDrive back to Home Assistant. This will still respect the maximum local backups set and will try to sync back the latest backups that exist in OneDrive while remaining under the set limit.
|
|
local_backup_num_to_keep:
|
|
name: Number of local backups
|
|
description: The maximum amount of backups to keep locally in Home Assistant
|
|
onedrive_backup_num_to_keep:
|
|
name: Number of OneDrive backups
|
|
description: The maximum amount of backups to keep in OneDrive
|
|
backup_interval_days:
|
|
name: Backup interval (days)
|
|
description: The backup creation frequency in days. For setting a sub-day frequency you can use a number between 0 and 1, so for example if the value here is set to 0.5, the backup frequency will occur every 12 hours.
|
|
backup_name:
|
|
name: Backup name
|
|
description: Name to use for the backups created by the add-on.
|
|
monitor_all_local_backups:
|
|
name: Monitor all local backups
|
|
description: Use this to monitor all locally created backups not just ones created by the Addon. All backup quota rules defined will be applied here including backup deletion when this is enabled.
|
|
ignore_upgrade_backups:
|
|
name: Ignore upgrade backups
|
|
description: When enabled, the add-on will ignore backups that are automatically created during upgrades (of Home Assistant / Addons)
|
|
backup_passwd:
|
|
name: Backup password
|
|
description: The password to use to protect the backups created and uploaded to OneDrive.
|
|
notify_on_error:
|
|
name: Notify on error
|
|
description: Enables persistent notifications in Home Assistant to notify of backup failures.
|
|
hass_api_timeout_minutes:
|
|
name: Hass api timeout (minutes)
|
|
description: This allows you to set the timeout configured when calling the Home Assistant APIs.
|
|
exclude_media_folder:
|
|
name: Exclude media folder
|
|
description: When enabled, a partial backup will be created without the media folder
|
|
exclude_ssl_folder:
|
|
name: Exclude ssl folder
|
|
description: When enabled, a partial backup will be created without the ssl folder
|
|
exclude_share_folder:
|
|
name: Exclude share folder
|
|
description: When enabled, a partial backup will be created without the share folder
|
|
exclude_local_addons_folder:
|
|
name: Exclude local addons folder
|
|
description: When enabled, a partial backup will be created without the addons/local folder
|
|
backup_allowed_hours:
|
|
name: Allowed hours
|
|
description: This accepts a range of hours from 0 to 23 for which only during these hours will backups be performed. If a backup is required it will be performed at the first window allowed in the defined hours. The format of this is one or more ranges seperated by a comma. A range is specified by a dash.
|
|
backup_instance_name:
|
|
name: Backup instance name
|
|
description: This is used to distingiush between multiple Home Assistant installations backing up to the same OneDrive account. OneDrive backups will be seperated for each 'Instance Name'
|
|
sync_paths:
|
|
name: File Sync Paths
|
|
description: >
|
|
This allows you to specify a list of paths for the addon to sync to OneDrive so you can for example sync your **Media** folder to OneDrive and exclude it from the Backups allowing you to save storage space (as this will only be stored once). Files are stored under a new directory called "FileSync" under the App Folder root. Source folder structure is maintained under this folder.
|
|
Sync (sub)folders supported must be under one of the following roots: /config, /ssl, /share, /media, /addons
|
|
You can specify an array of items here containing "path" and "recursive".
|
|
See documentation for full usage details.
|
|
file_sync_remove_deleted:
|
|
name: Remove deleted files during File Sync
|
|
description: When enabled, the FileSync folder on OneDrive will mirror your included sync_paths meaning any 'extra' content that remains in OneDrive will be removed.
|
|
excluded_addons:
|
|
name: Excluded Addons
|
|
description: When enabled, partial backups will be created excluding the addons specified in this list. You need to specify the addon id (slug) in this list.
|
|
log_level:
|
|
name: Log Level
|
|
description: You can opt to see more / less logs by adjusting the verbosity of the addon logs.
|