From 474d99d8b0032ab8f5ad53194141199eb907594b Mon Sep 17 00:00:00 2001 From: Thor Harald Johansen Date: Tue, 26 May 2020 18:21:22 +0200 Subject: [PATCH] Added README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a6e8a22 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +ZFS Automatic Snapshot Daemon + +This is a daemon, written in Python 3, that will schedule regular +snaphots of ZFS datasets (pools, filsystems) according to a set of +configurable schedules. Options for interval and crontab-style +schedules are available. + +The daemon only includes an installer for macOS at the moment, +but a multi-platform installer is coming soon. + +As of now, snapshots are conditional. A snapshot will only be taken +if a dataset has been modified since the last snapshot. An option +to turn this off per schedule is coming soon. + +The daemon will not interfere with other snapshots you may have +on the system unless you give them names that match the syntax +in `zasd` and look like they belong to one of the configured +shchedule tags. This won't happen unless you do it on purpose.