Skip to content

About

ZFS autobackup is used to periodicly backup ZFS filesystems to other locations. Easy to use and very reliable.

Topics

Resources

Stars

800 stars

Watchers

21 watching

Forks

Latest commit

 

History

940 Commits

Folders and files

Repository files navigation

ZFS autobackup

Tests Coverage Status Python Package CodeQL

Introduction

ZFS-autobackup tries to be the most reliable and easiest to use tool, while having all the features.

You can either use it as a backup tool, replication tool or snapshot tool.

There are no config files: just test your command on the commandline and copy/paste it to a cron or script. Use --test to see what it will do without changing anything, and --debug to see the actual ZFS commands it runs.

How it works

Mark the datasets you want to back up with a ZFS property, and run zfs-autobackup:

Source datasets with the autobackup property are sent to the target

After the first full backup, every run only sends the changes since the last snapshot that both sides have:

Only the diff since the common snapshot is sent

Install it on one machine only. It reaches the other side over SSH, so it works local, push, pull or pull+push:

Local, push, pull and pull+push

Features

  • Works across operating systems: Tested with Linux, FreeBSD/FreeNAS and SmartOS.
  • Low learning curve: no complex daemons or services, no additional software or networking needed.
  • Plays nicely with existing replication systems. (Like Proxmox HA)
  • Creates consistent snapshots. (takes all snapshots at once, atomically.)
  • Also supports complex backup geometries.
  • ZFS encryption support: Can decrypt / encrypt or even re-encrypt datasets during transfer.
  • Supports sending with compression. (Using pigz, zstd etc)
  • IO buffering to speed up transfer.
  • Bandwidth rate limiting.
  • Multiple backups from and to the same datasets are no problem.
  • Replicates clones, and keeps the clone relationship on the target.
  • Resilient to errors.
  • Ability to manually 'finish' failed backups to see what's going on.
  • Uses progressive thinning for older snapshots.
  • Uses bookmarks and holds to protect the snapshots it needs.
  • Automatic resuming of failed transfers.
  • Easy migration from other zfs backup systems to zfs-autobackup.
  • Gracefully handles datasets that no longer exist on source.
  • Complete and clean logging.
  • Includes zfs-autoverify and zfs-check to verify your backups.
  • All code is regression tested against actual ZFS environments.
  • Easy installation:
    • Just install zfs-autobackup via pip.
    • Written in python and uses zfs-commands, no special 3rd party dependencies or compiled libraries needed.

Getting started

pip install zfs-autobackup

Please look at our wiki to Get started.

Or read the Full manual.

Sponsor list

This project was sponsored by:

About

ZFS autobackup is used to periodicly backup ZFS filesystems to other locations. Easy to use and very reliable.

Topics

Resources

Stars

800 stars

Watchers

21 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages