diff --git a/README.md b/README.md index 7b32160..e0a53f6 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,16 @@ Snapshots can be named so you can create groups of them, e.g. "hourly snapshots" An additional tool takes care of exporting such snapshots, and uploading them to a remote server. - # Installation -Simply place all `*.sh` files of the package into directory `/usr/local/sbin/`. +Installation: +1. place all `*.sh` files of the package into directory `/usr/local/sbin/` + +Done! Is your ZFS pool name other than _zroot_? Then set the _ZPOOL_ environment +variable to your zpool name when calling these scripts. + +Need to control multiple ZFS pools? See section "Managing multiple ZFS Pools" below. # Snapshot management @@ -191,3 +196,35 @@ variables: # take selective backup EXTRA_EXCLUDES="/jails/test.dom.com" /usr/local/sbin/zfsbk.sh mybk 1 + +# Managing multiple ZFS Pools + +Simply run these scripts once for each pool, setting the _ZPOOL_ environment variable +accordingly. + +# Ancillaries + +## Warranty + +By using this software you release the author(s) from any claim. + +You are aware that working with filesystems is dangerous and exposes to +complete data loss. This script has been written with care for reliability, +tested for a number of scenarios, and used in a number of servers. + +Because of the inherently partial nature of testing, you are aware that this +brings no guarantees that it'll work for your scenario. + +## License + +Copyright (c) 2014-present, Michele Mazzucchi +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +