diff --git a/README.md b/README.md index c0fc0de..9f7503f 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ It has the following features: * Also supports local backups. * Even supports pulling data from a source-host and pushing backup to target host by ssh. * Can be scheduled via a simple cronjob orrun directly from commandline. +* Backups and snapshots can be named to prevent conflicts. (multiple backups from and to the same filesystems are no problem) * Always creates new snapshots, even if the previous backup was aborted. * Ability to 'finish' aborted backups to see what goes wrong. * Checks everything and aborts on errors. @@ -19,14 +20,26 @@ It has the following features: * Written in python and uses zfs-commands, no 3rd party dependencys or libraries. * Easy to debug and has a test-mode. Actual unix commands are printed. -Usage -===== + +Example usage +============= + +In this example we're going to backup a SmartOS machine called `smartos01` to our fileserver called `fs1`. + +Its important to choose a uniq and consistent backup name. In this case we name our backup: `smartos01_fs1`. Select filesystems to backup ---------------------------- + On the source zfs system set the ```autobackup:name``` zfs property. -For example, to backup a complete smartos host: - +``` +[root@smartos01 ~]# zfs get -t filesystem autobackup:smartos01_fs1 +NAME PROPERTY VALUE SOURCE +zones autobackup:smartos01_fs1 true local +zones/1eb33958-72c1-11e4-af42-ff0790f603dd autobackup:smartos01_fs1 true inherited from zones +zones/3c71a6cd-6857-407c-880c-09225ce4208e autobackup:smartos01_fs1 true inherited from zones +zones/3c905e49-81c0-4a5a-91c3-fc7996f97d47 autobackup:smartos01_fs1 true inherited from zones +```