README.md

Home Assistant Add-on: Samba Backup

Create backups and store them on a Samba share.

About

This add-on lets you automatically create Home Assistant backups and store them on a Samba share. This does work with Samba shares that require authentication by username/password or allow guest access.

Installation

1. Navigate in your Home Assistant frontend to Settings -> Add-ons -> Add-on Store and add this URL as an additional repository: https://github.com/thomasmauerer/hassio-addons
2. Refresh your browser.
3. Find the "Samba Backup" add-on and click the "INSTALL" button.
4. Configure the add-on and click on "START".

Configuration

The host and the share parameters are always required. If you do not specify any username and password, the Samba share has to be configured to allow guest access for this to work.

Example configuration:

host: 192.168.178.100
share: my-share
target_dir: backups/ha-backups
username: my-user
password: my-password
keep_local: 5
keep_remote: 10
trigger_time: 04:00
trigger_days:
  - Mon
  - Wed
  - Fri
exclude_addons:
  - core_mariadb
exclude_folders:
  - media
backup_name: {type} Backup {date}

Note: This is just an example, don't copy and paste it! Create your own!

Please check the Documentation for a complete reference of all configuration options.

Want to contribute?

Any kind of help or useful input/feedback is appreciated! Please also check the forum thread of this add-on for infos and discussions.