nielsmaerten/hassio-rclone-backup

Home Assistant addon to automatically sync backups to remote locations using Rclone

Rclone Backup

Backup your Home Assistant configuration or backups to over 70 cloud providers using Rclone.

This pairs well with the custom integration Auto Backup which provides a highly configurable way to create backups and have them deleted after a given period.

Rclone Backup can sync specific backups, e.g. backups starting with AutoBackup* to a cloud provider, and when that backup is deleted from Home Assistant it will be removed from the cloud provider as well.

You can also directly sync your Home Configuration e.g. /config, /share, /ssl, /media to a cloud service or to another machine using SFTP. Rclone is smart and will only upload changed files.

The addon also supports monitoring rclone and configuring or exploring remotes through rclone-webui-react.

Installation

Add the repository URL under Supervisor → Add-on store → ⋮ → Manage add-on repositories

https://github.com/jcwillox/hassio-rclone-backup

Example

Rclone is a powerful tool, you could for example use the crypt and googledrive remotes to automatically encrypt your backups and upload them to google drive.

rclone.conf

[google]
type = drive
scope = drive
token = REDACTED
; immediately delete backups instead of sending them to the trash
use_trash = false

[hassbackup]
type = crypt
remote = google:Backup/Home Assistant
filename_encryption = off
directory_name_encryption = false
password = REDACTED
password2 = REDACTED

Addon configuration

jobs:
  - name: Sync Daily Backups
    schedule: 10 4 * * *
    command: sync
    sources:
      - /backup
    destination: 'hassbackup:'
    include:
      - DailyBackup*
    exclude: []
    # we can also disable google drive trash using flags
    flags:
      drive-use-trash: false
dry_run: false
config_path: /config/rclone.conf

Providers

This is a list of providers this addon supports synchronizing backups with, for an up-to-date list see rclone.org/#providers.

1Fichier, Akamai Netstorage, Alibaba Cloud (Aliyun) Object Storage System (OSS), Amazon Drive (See note), Amazon S3, Backblaze B2, Box, Ceph, China Mobile Ecloud Elastic Object Storage (EOS), Arvan Cloud Object Storage (AOS), Citrix ShareFile, Cloudflare R2, DigitalOcean Spaces, Digi Storage, Dreamhost, Dropbox, Enterprise File Fabric, Fastmail Files, FTP, Google Cloud Storage, Google Drive, Google Photos, HDFS, Hetzner Storage Box, HiDrive, HTTP, Internet Archive, Jottacloud, IBM COS S3, IDrive e2, IONOS Cloud, Koofr, Leviia Object Storage, Liara Object Storage, Linkbox, Linode Object Storage, Mail.ru Cloud, Memset Memstore, Mega, Memory, Microsoft Azure Blob Storage, Microsoft Azure Files Storage, Microsoft OneDrive, Minio, Nextcloud, OVH, Blomp Cloud Storage, OpenDrive, OpenStack Swift, Oracle Cloud Storage Swift, Oracle Object Storage, ownCloud, pCloud, Petabox, PikPak, premiumize.me, put.io, Proton Drive, QingStor, Qiniu Cloud Object Storage (Kodo), Quatrix by Maytech, Rackspace Cloud Files, rsync.net, Scaleway, Seafile, Seagate Lyve Cloud, SeaweedFS, SFTP, Sia, SMB / CIFS, StackPath, Storj, Synology, SugarSync, Tencent Cloud Object Storage (COS), Uptobox, Wasabi, WebDAV, Yandex Disk, Zoho WorkDrive, The local filesystem.