Home Assistant Google Drive Backup
add
Backup Statistics

timer Last Backup

update Next Backup in

sync_problem Error while backing up

The add-on got the error below while trying to sync your backups. Some transient errors are expected (e.g. an upload could fail if the internet is down) but if this persist for more than a few minutes your backups won't get uploaded and the information you see on this page may be stale. If you file an issue on GitHub with the link below, it could be helpful to provide the logs downloaded from the "Download Logs" link below


disc_full Low Disk Space

It looks like you're low on disk space. The addon won't attempt to create a backup until you take action or more space becomes available. It looks like your backup folder in Home Assistant is full and only has left so creating another backup runs the risk of exhausting the space available. When Home Assistant runs out of disk space, it can stop responding and become very difficult to fix. This addon can only estimate how big the next backup will be based on your most recent one, it can't know how big the backup will be until its actually created.

To resolve this you can:

  • Free up space in Home Assistant. Addons like the Configurator can help you see what files might be taking up space.
  • Make your backups smaller (see this tip). You can also click the little info next to backups below to see which parts of them are taking up the most space.
  • Modify your settings add-on settings to store fewer backups in Home Assistant.
  • Delete existing backups from Home Assistant by clicking "Action" -> "Delete" on backups below. Make sure either you don't need them anymore or they're uploaded to Google Drive.
  • Modify your settings add-on settings and disable "Stop on low disk space". This will make the addon stop checking disk usage, do so at your own peril.
  • Click "Create backup anyway" to bypass this warning just this one time. This is useful if you're confident that the backup actually will fit in the available space. Again, do so at your own peril.
disc_full Google Drive is Full

Google Drive is full, backups can't continue until space is available. The most recent upload attempt is and Google says you have available. You can go to Google Drive's quota page to see what's using up space in your Google Drive, but because that space is shared between several Google products (e.g. Gmail, Google Photos) one of those products might be using the space instead. You can see your usage across all those products on Google's storage settings page.

To resolve this you can:

error Couldn't Log in with Google

Google Drive rejected your credentials. Your backups will not be uploaded until this is resolved.

This can happen if:

  • You revoked the add-on's access in your Google account settings.
  • You recently changed your Google account password.
  • You haven't used your Google account for over 6 months.
  • The add-on's credentials changed, or Google changed them.

To resolve this, you'll need to authenticate this add-on with Google again. If that still doesn't help, you may need to update the add-on

delete_forever Couldn't delete old backups in Home Assistant

The add-on ran into an error (HTTP 400) trying to delete your oldest backup. This can happen sometimes (especially if you just installed the add-on) when Home Assistant's cache of your existing backups is out of sync. The add-on can't continue until this is resolved.

To resolve this, you can try:

  • Refreshing your backups by going to the "Backups" page in Home Assistant and clicking the refresh icon in the top right.
  • Restarting the machine Home Assistant runs on.

The add-on will retry periodically to check if the issue is resolved. To retry now, click "Try Syncing Again" below. If the above doesn't help, please file an issue on GitHub to get more help.

cloud_off Couldn't Reach Google Drive (DNS error)

The add-on couldn't resolve Google Drive's server address. Backups can't be uploaded without being able to reach Google Drive.

Please ensure:

  • The internet is working.
  • The server www.googleapis.com is reachable from your Home Assistant machine. Some ad-blocking and firewall software (e.g. Ad Guard, Pi-hole, etc) can block this addresses.
arrow_drop_down Show DNS info

Below is the list of names and IP Addresses Google's API servers resolve to. Next to each is the result from an attempt the add-on has made to ping the address. This may help in determining if something in your network is blocking access to one of Google's API servers, or if Google's API servers are having problems.

You can also try restarting this add-on, the supervisor, or Home Assistant.

cloud_off Google Drive Connection Timeout

The connection timed out or was closed unexpectedly while trying to communicate with Google Drive. Backups can't be uploaded without being able to reach Google Drive reliably. This can happen transiently from time to time and the addon will continue to attempt to sync your backups. This problem almost always resolves itself after some time.

Please ensure:

  • The internet is working.
  • The server www.googleapis.com are reachable from your Home Assistant machine. Some ad-blocking and firewall software (e.g. Ad Guard, Pi-hole, etc) can block or throttle traffic to this address.
arrow_drop_down Show DNS info

Below is the list of names and IP Addresses Google's API servers resolve to. Next to each is the result from an attempt the add-on has made to ping the address. This may help in determining if something in your network is blocking access to one of Google's API servers, or if Google's API servers are having problems.

You can also try syncing again or restarting this add-on, the supervisor, or Home Assistant.

cloud_off Can't Connect to Google Drive

Google Drive refused an attempt to connect with it. Backups can't be uploaded without being able to reach Google Drive.

Please ensure:

  • The internet is working.
  • The server www.googleapis.com are reachable from your Home Assistant machine. Some ad-blocking and firewall software (eg Ad Guard, pi-hole, etc) can block or throttle traffic to this address.
arrow_drop_down Show DNS info

Below is the list of names and IP Addresses Google's API servers resolve to. Next to each is the result from an attempt the add-on has made to ping the address. This may help in determining if something in your network is blocking access to one of Google's API servers, or if Google's API servers are having problems.

You can also try syncing again or restarting this add-on, the supervisor, or Home Assistant.

vpn_key Invalid Backup Password

The add-on couldn't find your backup password in your secrets.yaml file. Backups can't be created until you either configure a valid password or remove it.

This can happen if:

  • Your secrets.yaml file isn't present in your Home Assistant configuration directory
  • The password key isn't present in your secrets.yaml file.

Please review your settings add-on settings to ensure you've set the backup password you intended, then sync again.

settings_backup_restore Backup Already in Progress

The add-on couldn't create a backup on schedule because one is already in progress. Home Assistant can only create one backup at a time. This can happen if:

  • The add-on was started while a backup was already in progress
  • A backup was started outside of the add-on, eg manually from the supervisor Backups page.

Typically you don't need to do anything to resolve this, as the add-on will pick up again once the backup in progress finishes. If you are certain no backup is in progress already or this error sticks around, you can try restarting the addon or Home Assistant's host machine.

delete_forever Attempting to Delete Multiple Backups

The add-on attempted to delete (?) backup(s) from Google Drive and (?) backup(s) from Home Assistant. Under normal circumstance, the add-on will only delete one backup at a time (the oldest). This warning is produced to prevent the add-on from accidentally deleting your history of backups. This is normal if you recently lowered the number of backups to keep in Google Drive or Home Assistant.

To be deleted from Google Drive:


    

To be deleted from Home Assistant:


    

To resolve this you can:

  • Review the settings add-on settings and increase the number of backups you keep.
  • Click "Allow Deletion" below to permit these deletions to happen this one time.
  • Click "Never ask again" below to permit the deletes this time and in the future (not recommended)
cloud_off Google Server Error

Google returned a server error (HTTP code 500) while trying to backup your backups.

This happens sometimes for reasons beyond anyone's control and almost always the problem goes away on its own. The add-on will attempt uploading again soon, but you can also click "Try Syncing Again" below to make it retry now.

If this error keeps sticking around, you can try:

  • Making sure the internet is working fine.
  • Making sure you're able to log into your Google Drive account and upload files without problems.
  • Re-authenticating the add-on with Google Drive (click "ACTIONS" -> "Reauthorize Google Drive" up top)
  • Restarting the add-on, Home Assistant, or the supervisor.
  • Reinstalling the add-on.
cloud_off Google Session Expired

Google returned a server error (HTTP code 404) while trying to upload your backups.

In most cases, this indicates that your upload took too long to upload. According to Google's documentation if an upload takes longer than a week then it will be forcibly cancelled and return this error. This can happen if your internet is very slow or your backups are very large, however the developer of this addon suspects this can happen in more common circumstances. If the below options don't help, please file an issue on GitHub with as much detail as you can stomach to help him look into it.

If this error keeps sticking around, you can try:

  • Syncing again (if it hasn't already started) by clicking "Try Syncing Again" below.
  • Making sure you're able to log into your Google Drive account and upload files without problems.
  • Ensuring your internet connection is reasonably fast by doing a speed test
  • Making your backups smaller. Usually backups are large because of a huge sensor database. You can keep a smaller history by setting up the recorder component purge settings in Home Assistant
  • Restarting the add-on, Home Assistant, or the supervisor.
  • Reinstalling the add-on.
folder_special Existing Backup Folder Found

The add-on found a backup folder named "" in Google Drive that might already have backups in it. This is normal if you've used this addon before, but you'll need to decide where backups should go before this will start backing up again. Click here to see the folder contents in Google Drive.

To resolve this you can:

  • "Use the folder" and merge in backups from this Home Assistant instance. If this instance has newer backups, then some of the backups in Google Drive might get deleted to make room for these newer ones (this depends on your settings). You probably want this option if you just reinstalled the addon.
  • "Choose a different folder" to store backups in, ignoring the existing folder. You probably want his option if you have multiple Home Assistant instances that should all back up to their own folder.
  • Or "create a new folder" to automatically create a folder and ignore the existing one. The new folder will be created at the root of your My Drive.

Note: If you run multiple instance of Home Assistant with this addon using the same Google Drive account, its recommended that you use a different folder for each instance. Otherwise they'll delete each other's backups!

folder_special Please choose a backup folder

You've chosen to upload your backups to a folder of your choosing. Click the link below to open a new window and select the folder in Google Drive you'd like to store your backups in.

You've chosen to upload your backups to a folder of your choosing. Please navigate to the addon settings to specify a folder to store backups in.

folder_open 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. Doing this gives the addon permission to store backups in that folder. open_in_new Choose Folder save Save
  • If you'd rather not specify the folder for uploads, please return to your settings add-on settings and change your preference.

  • Your backups in Home Assistant will be re-uploaded to the new folder. If you already have them in an existing folder in Google Drive and you'd like to avoid this, please move them in manually before selecting the folder.
  • If you run multiple instances of Home Assistant with this addon using the same Google Drive account, its recommended that you use a different folder for each instance. Otherwise they'll delete each other's backups!

Note: Google's authentication mechanisms require you to select your folder through an external domain, which is where the "Choose Folder" link will take you. See here for details if you'd like to know more about why.

sync_problem Couldn't use your backup folder

The addon couldn't use the folder you chose for storing backups. The addon can't backup your backups until you resolve this. This can happen if:

  • The folder was deleted
  • You lost permissions on the folder
  • You gave the addon an invalid folder ID
  • You signed in with drive using different credentials
  • Something else made the folder unreadable

To resolve this, you can:

  • Use the link below to choose a new folder to store backups in.

    folder_open 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. Doing this gives the addon permission to store backups in that folder. open_in_new Choose Folder save Save

  • Open your settings add-on settings and, enter a valid "Backup Folder Id".

  • Open your settings add-on settings and deselect "Manually specify the backup folder". The addon will automatically create a new folder for you.

  • If the folder still exists, you can restore access to it by the addon by ensuring that your google account has access to it. The folder should be accessible from this link. After doing so, click "sync now" below to try syncing again.

Note: Google's authentication mechanisms require you to select your folder through an external domain, which is where the "choose folder" link below will take you. See here for details if you'd like to know more about why.

pause Backup is Paused

Sync was cancelled because you requested it. The addon will not resume syncing for another hour unless you take action.


Please note:

  • A pending backup can't be stopped once its started, because its creation is managed by Home Assistant. Being "Paused" only stops the addon from creating new backups and syncing them with Google Drive.

  • You can resume by clicking the link below or just waiting.

error Couldn't Refresh Google Drive Credentials

The addon was unable to refresh your credentials with Google Drive. When it tried, Google said:

    (?)
  

This can happen if:

  • The domain https://habackup.io, which grants your credentials from Google Drive (click here to see why), is having trouble communicating with Google Drive.
  • Google Drive is experiencing a temporary outage.
  • Something else has gone wrong with your Google Drive credentials.

Usually this problem will resolve on its own, but you can try:

  • Syncing again with the button below. The addon will retry on its own periodically.
  • Re-authenticating this add-on with Google again. Its unlikely this will resolve the problem, but it also won't cause you to lose any of your data.
  • If the problem persists, file an issue on GitHub to let the developer of this addon know about it.
error Couldn't Refresh Google Drive Credentials

The addon was unable to refresh your credentials with Google Drive. When it tried, https://habackup.io said:

    (?)
  

This can happen if:

  • The domain https://habackup.io, which grants your credentials from Google Drive (click here to see why), is having some unexpected problems.
  • Something else has gone wrong with your Google Drive credentials.

Usually this problem will resolve on its own, but you can try:

  • Syncing again with the button below. The addon will retry on its own periodically.
  • Re-authenticating this add-on with Google again. Its unlikely this will resolve the problem, but it also won't cause you to lose any of your data.
  • If the problem persists, file an issue on GitHub to let the developer of this addon know about it.
error Unable to Reach Home Assistant Supervisor

The addon was unable to connect to the Home Assistant Supervisor. This addon requires the supervisor to be running to create backups, load configuration, etc. Without the supervisor the addon will not be able to do anything useful. Typically this should never happen, and indicates that something is wrong with your Home Assistant installation.

To resolve this you can try:

  • Syncing again with the button below. The addon will retry on its own periodically.
  • Restarting the machine that Home Assistant runs on. Often this resolves transient problems the Home Assistant Supervisor might have.
  • If the problem persists, file an issue on GitHub to let the developer of this addon know about it.
error Unable to Talk to the Home Assistant Supervisor

The addon was unable to communicate with the Supervisor because it said the addon is unauthorized. This addon must communicate with the supervisor to create backups, load configuration, etc. Without the supervisor the addon will not be able to do anything useful. Typically this should never happen, and indicates that something is wrong with your Home Assistant installation.

  • Syncing again with the button below. The addon will also retry on its own periodically.
  • Restarting the addon, the supervisor, or the whole machine Home Assistant is running on. Sometimes the supervisor can get into a bad state and this works around it.
  • Checking the Supervisor's logs ("Supervisor" > "System" > "Logs") to see if any errors might indicate what the problem is.
  • If the problem persists, file an issue on GitHub to let the developer of this addon know about it. He might be able to help.
error A Request to the Supervisor Timed Out

The addon was unable to communicate with the Supervisor because it timed out. This addon must communicate with the supervisor to create backups, load configuration, etc. Without the supervisor the addon will not be able to do anything useful. This usually resolves itself after the addon retries, but if you see this error stick around for a while you can try

  • Syncing again with the button below. The addon will also retry on its own periodically.
  • Restarting the addon, the supervisor, or the whole machine Home Assistant is running on. Sometimes the supervisor can get into a bad state and this works around it.
  • If the problem persists, file an issue on GitHub to let the developer of this addon know about it. He might be able to help.
error The Supervisor Returned an Unexpected Response

The addon was unable to communicate with the Supervisor because it gave back an unreadable response. This addon must communicate with the supervisor to create backups, load configuration, etc. Without the supervisor the addon will not be able to do anything useful. This usually resolves itself after the addon retries, but if you see this error stick around for a while you can try:

  • Syncing again with the button below. The addon will also retry on its own periodically.
  • Restarting the addon, the supervisor, or the whole machine Home Assistant is running on. Sometimes the supervisor can get into a bad state and this works around it.
  • If the problem persists, file an issue on GitHub to let the developer of this addon know about it. He might be able to help.
error Unable to write to the file system

The addon was unable to write to the file system on this machine. Normally this indicates there is a problem with the Home Assistant supervisor, which is responsible for creating the file system this addon needs to function. Here are some reasons this might happen:

  • You recently upgraded Home Assistant. Sometimes during an upgrade, the docker environment Home Assistant creates for the addon can get messed up. If this is the problem, then restarting the host machine where Home assistant is running will usually resolve it.
  • Your machine may have run out of space. Home Assistant will sometimes make the file system read-only to protect itself if it is close to running out of space, causing this error. You should be able to see an estimate of how much space is remaining down below on this page or by going to "Supervisor" > "System" in the Home Assistant UI.
  • If none of the above helps and the problem persists, file an issue on GitHub to let the developer of this addon know about it. He might be able to help.
error Google drive Returned an Unexpected Response

The addon was unable to communicate with Google Drive because it gave back an unreadable response. Without being able to communicate with Google Drive, the addon will not be able to transfer backups to the cloud. This usually resolves itself after the addon retries, but if you see this error stick around for a while you can try:

  • Syncing again with the button below. The addon will also retry on its own periodically.
  • Restarting the addon, the supervisor, or the whole machine Home Assistant is running on.
  • If the problem persists, file an issue on GitHub to let the developer of this addon know about it. He might be able to help.
error_outline Network Storage Inactive

The addon could not request a backup in your configured network storage because it looks like Home Assistant can't access it. The network storage the addon tried to use is named "".

To resolve this, you can:

  • Modify your settings add-on settings to store backups on a different storage or the local disk.
  • Resolve whatever issues are causing Home Assistant to be unable to access the network storage. After doing so it may take some time for Home Assistant to "notice" that the share is available again.
error_outline Unrecognized Network Storage

The addon could not request a backup in your configured network storage because Home Assistant doesn't recognize it. This is likely to happen if you previously configured the addon to create backups on external storage but then deleted the network storage configuration from Home Assistant. The storage the addon tried to use is named "".

To resolve this, you can modify your settings add-on settings to store backups on different storage or the local disk.

error Error details

info_outline Share Error Reports?

If you select yes, the text of unexpected exceptions this add-on produces will be sent to a server maintained by the developer. This is completely optional, but helps give him a heads up for problems with new releases and aids in providing better help messages when things go wrong. If you're unsure, just select "No". You can always change this in the settings menu up on the top right of the page.

info_outline Stop Addons feature is going to be removed

It looks like you're using the "Stop Addons" feature when creating backups. The maintainer of this addon would like to remove this feature because:

  • It was introduced long ago before Home Assistant had a built in way to let addons know they're in the middle of a backup. Now that it does, all addons the developer is aware of handle being backed up live correctly.
  • Frankly, it doesn't work very well. There are lots of cases where addons don't get restarted after a backup. Its a difficult feature to get right.
  • It confuses newer users who may not know the trouble it can cause.

If you have a good reason to keep this feature around, please let the developer of this addon know by commenting on the Github issue linked below. Otherwise the developer will remove the "Stop Addons" feature in a future release. To stop seeing this message either remove "Stop Addons" in your settings or click "DISMISS" below.

info_outline 'Snapshots' have been renamed to 'Backups'

In August 2021 the Home Assistant team announced that 'snapshots' will be called 'backups' moving forward. This addon exposes a binary sensor to indicate if snapshots are stale and another sensor that publishes details about backups. Both of the sensors used 'snapshot' in their names and values, so they had to be changed to match the new language. In the spirit of "not breaking your stuff" the addon will only start using the new names and values if you tell it to, just in case you have automations or UI using the old sensor names/values.

  • If you don't have any automations based on these sensors, you can just click 'Use the new names and values'.
  • If you do, you can either dismiss this message or update your automations/UI to use the new names and values.
  • You can look at this document to see exactly how the sensors have changed.
  • You can change this later in the settingsadd-on settings if you choose. Look for it under "Uncommon Options"

info_outline Ignoring upgrade backups is recommended

With your current settings, this addon assumes any backup it finds should be uploaded to Google Drive. This can create undesirable behavior when you upgrade Home Assistant or an addon and an automatic partial backup is created by Home Assistant for the upgrade (this is Home Assistant's default behavior).

For Example If you save 4 full backups in Google Drive and then upgrade 4 add-ons, the 4 partial backups Home Assistant automatically creates would overwrite ALL of the full backups this add-on made previously leaving you with no full backups to restore from until the next one is made 24 hours or more later. Most people don't want that to happen, as it leaves a possible gap in your backup strategy.

To prevent this most people enable the "Ignore upgrade backups" setting in this addon, which will cause it to completely ignore these partial upgrade backups. Moving forward this will be enabled by default for new installations, and it is recommended for everyone. Because you're upgrading from an older version of the addon that had different behavior, you have to choose. You can also enable some other features in the settingsadd-on settings that might be useful for this, such as:

  • The setting 'Delete ignored backups after: X' can be used to automatically delete upgrade backups after some time period, which helps reclaim the space they might use.
  • The 'Ignore Other Backups' setting makes the addon ignore any backup it didn't create, including 'upgrade' backups.
If none of this makes any sense to you, just click "Start ignoring upgrade backups" below to make this notification go away.

info_outline Your credentials with Google may expire

Google recently announced changes they're making to how their OAuth credentials are generated. You previously followed these instructions to set up credentials the add-on can use to upload to Google Drive. If you did that before March 16 2022, Google is going to make those credentials invalid in October of 2022. If you are affected this means that in October 2022 the add-on will be unable to authorize with Google Drive and your backups will not get uploaded.

While annoying, this change is also somewhat expected. Using Google Cloud credentials for a local installation like this is not something Google 'intended' for us to do, it isn't an officially supported way of using their services. We can still make do though.

If you are affected, you likely received an email from Google titled 'Migrate your OAuth out-of-band flow'. To make your credentials work, please follow the steps linked here to make your credentials and reauthorize the addon. You don't need to follow all the steps exactly; you just need to modify what you have to match up with the instructions. In particular please ensure that:

  • You can skip steps 0, 1, and 2 because you already did them
  • In step 3, ensure your "OAuth Consent Screen" has a Publishing status of "In production". You don't need to create a new consent screen.
  • In step 4, ensure your credentials use application type "TVs and Limited Input Devices". If not, you will need to create new credentials, which will create a new client ID and client secret you can use to reauthorize the addon.
Once you do, please reauthorize the add-on with Google Drive. You can also wait until your credentials stop working and regenerate them then. There is no rush.

Use Ingress instead?

The latest version of this add-on supports ingress. Ingress allows this web interface to be embedded within Home Assistant, which is usually more secure because it delegates authentication to the same mechanisms you've configured in Home Assistant (e.g. SSL and username/password). Currently this interface is being served on an additional port outside of Home Assistant which is less secure.


Select YES to only use ingress to access this interface. This is recommended, as ingress is almost always more secure. In the future you can access this interface by following the "WEB UI" link from the add-on installation page or embedding it in your Home Assistant sidebar from the same place.


Select NO to continue exposing a web interface on an open port with the SSL and authentication settings you choose. The port, which defaults to 1627, can be changed from the add-on page in Home Assistant.


You can change this option any time from the settings menu. No matter which you choose, the interface will be available through ingress.


Restore a Backup

Backups must be restored through the supervisor Backups page. You can restore a backup by navigating to "Settings" > "System" > "Backups" from the Home Assistant Web-UI, or by clicking the button below to navigate there by a direct link. Depending on how you access the Home Assistant Web-UI the direct link may not work, so you'll just have to navigate there.

info_outline Double check your ignored backups

Because this addon gets a limited view of the world, it might not be able to accurately determine if all of your older backups were created by the addon. Its recommended that you check below to ensure that all of the backups the addon is ignoring now are the ones you intend to have ignored. If not, you can click on an ignored backups to see its details and click "Don't ignore" to have the addon include them in future backup, clean-up, etc.

timer Taking a backup soon

Since the addon just started up a few minutes ago, it's going to wait a few minutes before taking a backup to make sure that's what you want. Look below to see exactly how long before the next backup. You can wait for that to happen, change your settingsadd-on settings to something different, or just click the button below to let the automatic backup happen immediately.

info_outline

You don't have any backups in Google Drive or Home Assistant yet.

refresh

Waiting for backups to load. If you don't see this go away soon, make sure the add-on is still running. Info on this page may be stale until then.