DevOps/bup-backup-sync
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Create a basic README

Browse Source
This commit is contained in:
Christian Wolf 2024-05-09 13:54:34 +02:00
parent 42b0b57742
commit 8b4f3a6f36
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# Offsite backup archiver
This script is intended to allow for offsite backups of a machine that is mostly suspended in S5 mode (suspend to disk).
In regular intervals this machine should be woken, some scripts called, and sent back to suspension.
This reduces the amount of online time to the bare minimum.
This script should be called regularly using e.g. Cron in order to work.
It has a few files in `/var/lib/bup-backup-trigger` that store the state between invocations.
The `trigger` file contains the time stamp of the next backup cycle.
Once, this has come, the scripts will be called in a serial manner and the next Monday morning will be set as next time for running the script.
Until then, the script terminates quickly and does not perform any operation.
Additionally, there is the option to disable the suspension to happen.
This can be useful if other maintenance is to be done that should not be interrupted.
Simply call the script with `--lock` to create a locking file that will prevent a suspension after the scripts have been iterated over.
To restore previous behavior, use the cli parameter `--unlock`, which will just reenable suspension.
There is the convenience option `--suspend` present, that allows to send the machine to sleep after the backup has finished and will no longer suspend automatically.
The scripts to do the actual offsite backup cloning is up to the user.
There should be a file (defaults to `repos` sibling file, see `repos.dist`) that defines these scripts and the order of their invocation.
Note, this is no shell script that is called but line by line interpreted.
You can also give another file using the `--repos` CLI argument.