summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick J Cherry <patrick@bytemark.co.uk>2014-06-13 14:33:14 +0100
committerPatrick J Cherry <patrick@bytemark.co.uk>2014-06-13 14:33:14 +0100
commit5158437fdb21f0c2176a616feacf3b771ebe7059 (patch)
tree79a632a1d5e57f52e8a711f2bd5dceb327bd5dc5
parent10eceff89a1f39479a047171d510ca8bb49bfac9 (diff)
Updated docs
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index 67619c7..af5f7ba 100644
--- a/README.md
+++ b/README.md
@@ -76,16 +76,20 @@ Configuring byteback-backup
You can now set "byteback-backup" on a daily cron job to start backing up the
server on a regular basis.
-Without any further options this will copy every file from the root downwards,
-excluding anything not on the same filesystem, i.e. kernel-based virtual
-filesystems (/proc, /sys etc.) network filesystems (NFS, SMB) and tmpfs or
-loopback mounts. To specify which filesystems to backup, add them to
-/etc/byteback/sources, one per line.
+Without any further options this will copy every file from the root downwards.
-It currently excludes /var/cache/apt/archives, /swap.file and
+It currently excludes /tmp, /var/tmp, /var/cache/apt/archives, /swap.file and
/var/backups/localhost which (on Bytemark systems) do not need to be part of
any backup. To specify which locations are excluded, add them to
-/etc/byteback/excludes, one per line.
+/etc/byteback/excludes, one per line. The filesystems /dev, /proc, /run and
+/sys are always excluded.
+
+It is possible to configure a full rsync filter by creating the file
+/etc/byteback/rsync_filter, which is parsed to rsync via the --filter flag.
+Note that excludes on the command line take precedence, unless the filter
+starts with an exclamation mark, which resets everything. If you do this,
+you'll need to specify /proc, /sys, etc manually. See the rsync manpage for
+more information about filters.
When the backup has completed successfully, the server will take a snapshot
so that the client can't alter the backups, and then "prune" the backup