Add-on Settings

Settings take effect right after saving them. If you enable or disable SSL, you may need to go to a different address to access the UI after the settings are saved. See the GitHub Readme for more help with settings.

Backups in Home Assistant The maximum number of backups to keep locally in Home Assistant, or 0 to disable clean-up of old backups entirely.

Backups in Google Drive The maximum number of backups to keep remotely in Google Drive, or 0 to disable clean-up of old backups entirely.

Delete Backups After Upload
Delete backups in Home Assistant immediately after uploading them to Google Drive. This can be useful if your machine is low on space, but your backups will only be stored in the cloud. Enabling this will cause "Backups in Home Assistant" to be ignored.

Delete Oldest Backup Before Making a New One
Makes the addon delete the oldest backup before a new one is created in Home Assistant or uploaded to Google Drive. When turned off (the default) the oldest backup will only be deleted after a new one has been created or uploaded. Be warned that if a backup fails to be created or uploaded to Google Drive, this can make you have one fewer than the number of backups you intended to keep there.

Ignore Other Backups
The addon will ignore any backups it didn't create. Ignored backups will not count toward "Backups in Home Assistant", get deleted, or get uploaded to Google Drive unless you manually tell the addon to do so.

Ignore "Upgrade" Backups
The addon will ignore backups with only one addon or folder inside them. This is useful if you'd like the addon to ignore backups that Home Assistant automatically creates while updating. Ignored backups will not count toward "Backups in Home Assistant", get deleted, or get uploaded to Google Drive up unless you manually tell the addon to do so.

Delete ignored backups after For any ignored backups, automatically delete them after this much time. Leave blank (the default) to never delete them. This can be any duration of time expressed as days, hours, minutes, and seconds. Be careful enabling this, you can see if you have any ignored backups by scrolling to the bottom of the list of backups under this dialog. Examples: '7 days', '36 hours', '1 hour, 30 minutes, 10 seconds', etc.

Days between backups The number of days between backup, or 0 to disable automatic backup creation.

Backup time of day The time of day when backups should be taken in the form 'HH:mm' (24 hour clock).

Password When set, creates backups protected by a password. This password will be required by Home Assistant when restoring the backup. Leave blank to require no password. You can specify a password from your secrets.yaml by using the syntax "!secret your_secret_key".

Re-enter password Re-enter your new password to ensure it matches.

Backup Name Template The template to use for naming new backup. See here for a list of all available options, your backup's name will look something like:

Manually specify the backup folder
Specify manually which folder backups should be uploaded into in Google Drive. If disabled, the addon will automatically create a folder in your My Drive whenever its needed. Click here to see the folder currently being used.

Backup Folder ID The Google Drive ID of the folder you'd like to upload backups into. You can get this id by navigating to the folder in Google Drive and copying it out of the URL. It should be a long sequence of characters at the end of the URL. For example if the URL for my folder is https://drive.google.com/drive/folders/1el4ZWcE0xdkIu_Yt_2kxk36qE7K5O188, then the Drive ID is 1el4ZWcE0xdkIu_Yt_2kxk36qE7K5O188 Use the "Choose Folder" button to open a new window where you can select the folder you'd like to use and paste its folder ID here. Doing this gives the addon permission to store backups in that folder. Choose Folder

Enable Staleness Notifications
When there is a problem with the backups, show a persistent notification in the Home Assistant interface.

Enable Backup Staleness Sensor
Publishes a sensor, binary_sensor.backups_stale, indicating if there is a problem uploading up or creating backups.

Enable Backup State Sensor
Publishes a sensor, sensor.backup_state, with the status of existing backups.

Send Error Reports
Sends information about errors to a database maintained by developers. This helps them identify problems with new releases and provide better help messages.

Confirm before large deletes
When disabled, the add-on will NOT stop and ask for confirmation before deleting more than one backup. Disabling this is dangerous because accidental misconfiguration can cause you to lose your history of uploaded backups.

Enable Google Drive Upload
When disabled, new backups will still be created in Home Assistant but will not be uploaded to Google Drive.

Stop on low disk space
When enabled, the addon will stop creating backups and ask for you to take action it thinks you don't have enough disk space. Disabling this is not recommended because recovering from an exhausted disk can be very difficult.

Expose this web interface on an additional port
Expose this web interface on an additional port. This isn't necessary unless you'd like to avoid accessing this web interface through ingress.

Keep Generational Backups
Keeps older backups longer on daily, weekly, monthly, and yearly rotations instead of just deleting the oldest backups. When using this feature, its recommended that you keep "Days Between Backups" at 1. See here for a deeper explanation.

Partial Backups
Partial backups allow you to selectively backup portions of your Home Assistant configuration, folders, and add-ons. Choose which parts of Home Assistant you'd like included in backups below. New add-ons will be automatically included in backups unless you update these settings to exclude them.

Stop addons
Some addons will not get backed up correctly while they are running. Any addons you select below will be stopped before a backup is taken and then started after it finishes. Note that if this addon is interrupted before a backup completes, you may have to restart the addon manually.

Look and Feel
Configure how this web UI looks

Background Color The background color of this interface. Click here to revert back to the default.

Accent Color The accent color of this interface (e.g. links, buttons, and other elements you can interact with). Click here to revert back to the default.

Uncommon Options
Most people don't need these options, but you might.

Google Drive Timeout The number of seconds the add-on should wait when connecting to or reading from Google Drive's servers.

Alternate DNS Servers When the add-on runs into trouble resolving Google Drive's IP Address, it will use this comma-delimited list of DNS Servers as alternate sources for name resolution. The servers must support TCP DNS lookups. The defaults are Google's public DNS servers.

Ignore IPv6 Addresses
Ignore ipv6 Addresses for the purposes or DNS resolution. Some users have had problems attempting to connect to Googles IPv6 servers because it is disabled on their network.

Google Drive IP Address Override If you're having problems with reaching Google Drive, you can use this to specify Google Drive's IP address manually and circumvent DNS lookup entirely. You can use a website like this one to lookup what address will work for www.googleapis.com.

Sync Interval How often the addon should check Home Assistant and Google Drive for backups. The addon will still sync more frequently when it starts, creates a new backup, or encounters errors. This can be any duration of time expressed as hours, minutes, and seconds. Examples: '1 hour', '30 minutes', '1 hour, 30 minutes, 10 seconds', etc.

Home Assistant Reporting Interval How often the addon should update the "Backups Stale" sensor in Home Assistant. The addon will still update immediately when it encounters errors. With longer values it may take longer after Home Assistant starts up before the "Backups Stale" sensor it available. This can be any duration of time expressed as hours, minutes, and seconds. Examples: '10 seconds', '3 minute', '2 hours, 30 minutes', etc.

Maximum Drive Upload Chunk Size Sets the maximum "chunk" size allowed for uploads to Google Drive. Larger sizes will upload faster but delay reports of progress and may cause interruptions on some network hardware. Between 1MB and 20MB is recommended, minimum is 256 kB. The value can be provided in any binary-prefix format, e.g. '256 Kb', '10 Mb', '3000Kb', etc.

Use old sensor names/values with "snapshot" instead of "backup"
When checked, the addon's state and staleness sensors will be published as binary_sensor.snapshots_stale and sensor.snapshot_backup and their attributes will reference "snapshots" instead of "backups". See here for a detailed explanation of why you might want this.