This release is a pre-release and may not be stable for production use.
ZFS autobackup
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.
You can select what to backup by setting a custom ZFS property. This makes it easy to add/remove specific datasets, or
just backup your whole pool.
Other settings are just specified on the commandline: Simply setup and test your zfs-autobackup command and fix all the issues you might encounter. When you're done you can just copy/paste your command to a cron or script.
Since it's using ZFS commands, you can see what it's actually doing by specifying --debug. This also helps a lot if
you run into some strange problem or errors. You can just copy-paste the command that fails and play around with it on
the commandline. (something I missed in other tools)
An important feature that's missing from other tools is a reliable --test option: This allows you to see what
zfs-autobackup will do and tune your parameters. It will do everything, except make changes to your system.
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)
- Automatically selects filesystems to backup by looking at a simple ZFS property.
- Creates consistent snapshots. (takes all snapshots at once, atomicly.)
- Multiple backups modes:
- Backup local data on the same server.
- "push" local data to a backup-server via SSH.
- "pull" remote data from a server via SSH and backup it locally.
- "pull+push": Zero trust between source and target.
- Can be scheduled via simple cronjob or run directly from commandline.
- 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.
- Resillient to errors.
- Ability to manually 'finish' failed backups to see whats going on.
- Easy to debug and has a test-mode. Actual unix commands are printed.
- Uses progressive thinning for older snapshots.
- Uses zfs-holds on important snapshots to prevent accidental deletion.
- 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.
- All code is regression tested against actual ZFS environments.
- Easy installation:
- Just install zfs-autobackup via pip.
- Only needs to be installed on one side.
- Written in python and uses zfs-commands, no special 3rd party dependency's or compiled libraries needed.
- No annoying config files or properties.
Getting started
Please look at our wiki to Get started.
Or read the Full manual
Sponsor list
This project was sponsored by:
- JetBrains
- https://rsync.net
- DatuX
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file zfs_autobackup-4.0rc1.tar.gz.
File metadata
- Download URL: zfs_autobackup-4.0rc1.tar.gz
- Upload date:
- Size: 91.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
922e4d88f0cee492a2108dd0dce9cca3742e04af46a40e121e0d3bfbd485005a
|
|
| MD5 |
f1d4b69be949a4194ae014cf3e1e23e0
|
|
| BLAKE2b-256 |
a6caa3bba7f8dd235df6065a50d34cb00900357945475e1d31d9e908eef0a920
|
File details
Details for the file zfs_autobackup-4.0rc1-py3-none-any.whl.
File metadata
- Download URL: zfs_autobackup-4.0rc1-py3-none-any.whl
- Upload date:
- Size: 110.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
efe518eea99a3a66e00933dfe9e1abd8062d95ea2531eb56162f02d69b78b31e
|
|
| MD5 |
03fb8828b43ec87331ffd95bb4e6a842
|
|
| BLAKE2b-256 |
bdb24827640b8be7acebbda43b8ea7c7744dc7552e37d722ab36696389ad34fe
|
