diff --git a/README.md b/README.md index 1fc022b..3786333 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ #### borg-backup A wrapper script for Borg, with optional utilization of ZFS snapshots. -Stops the service which is to be backed up, dumps the database and pushes -to a borg repository defined in a separate config file. + +- Stops the service which is to be backed up, restarts afterwars +- Dumps the possible database to the data directory +- Optionally takes a ZFS snapshot +- Makes a borg archive of the defined data directory +- Writes the status and time of latest backup to a file, meant to be echoed on interactive logins +- Keeps a log file +- Sends email on failures