diff --git a/README.md b/README.md index 57bea6e..022178e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ - # ZFS autobackup +# NOTE: this is the v3.4 development branch. Not ready for testing yet! + [![Tests](https://github.com/psy0rz/zfs_autobackup/workflows/Regression%20tests/badge.svg)](https://github.com/psy0rz/zfs_autobackup/actions?query=workflow%3A%22Regression+tests%22) [![Coverage Status](https://coveralls.io/repos/github/psy0rz/zfs_autobackup/badge.svg)](https://coveralls.io/github/psy0rz/zfs_autobackup) [![Python Package](https://github.com/psy0rz/zfs_autobackup/workflows/Upload%20Python%20Package/badge.svg)](https://pypi.org/project/zfs-autobackup/) [![CodeQL](https://github.com/psy0rz/zfs_autobackup/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/psy0rz/zfs_autobackup/actions/workflows/codeql-analysis.yml) @@ -10,26 +11,31 @@ ZFS-autobackup tries to be the most reliable and easiest to use tool, while havi 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. +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. +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) +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. +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. +* 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. +* 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. + * 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. @@ -48,10 +54,10 @@ An important feature that's missing from other tools is a reliable `--test` opti * 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. + * 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 @@ -63,6 +69,6 @@ Or read the [Full manual](https://github.com/psy0rz/zfs_autobackup/wiki/Manual) This project was sponsored by: -* JetBrains +* JetBrains * https://rsync.net * [DatuX](https://www.datux.nl)