diff --git a/README.md b/README.md index f560967..f5529bd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # backupsidecar -Backup sidecar that automatically creates backups of one PVC and saves it to another PVC via restic \ No newline at end of file +Backup sidecar that automatically creates backups of one PVC and saves it to another PVC via restic + +## Function +A cronjob inside the container runs in the configured interval creating the backup and purging old backups. +A notification is sent to gotify on completion of the backup or on error of either the backup or purge. + +## Environment Variables +| ENV Variable | Required |Description| Example Value +|--------------|----------|--------------|- +|INTERVAL|yes|cronjob interval string|15 14 * * *| +|RESTIC_REPOSITORY|yes|path of the restic repository|/mnt/backups/gitea| +|SOURCEDIR |yes|path of the path to backup|/mnt/toBackup/| +|KEEPLAST|yes|number of increments to keep (keep in mind that the number of backups to keep correlates with the interval in which they are created) |10| +|RESTIC_PASSWORD|yes|password for the restic repository|******| +|RUNONSTART|no|set to true to force a backup at the start of the container|true| +|GOTIFYHOST|yes|URL of the gotify server (without trailing slash)|https://gotify.example.com| +|GOTIFYTOKEN|yes|gotify app token|******| +|GOTIFYTOPIC|yes|gotify topic to include in the notification|gotify| \ No newline at end of file