Skip to content

Commit

Permalink
Mention default aws config
Browse files Browse the repository at this point in the history
  • Loading branch information
peterrus authored Apr 5, 2022
1 parent c9c73b7 commit ace36e7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[:star: Github](https://github.com/peterrus/docker-s3-cron-backup)

## What is it?
A modest little container image that periodically backups any volume mounted to /data to S3-compatible storage in the form of a timestamped, gzipped, tarball
A modest little container image that periodically backups any volume mounted to /data to S3-compatible storage in the form of a timestamped, gzipped, tarball. By default this container is configured to work with Amazon S3 but it should work with most S3-backends.

## Great, but how does it work?
An Alpine Linux instance runs nothing more than crond with a crontab that contains nothing more than one single entry that triggers the backup script. When this script is run, the volume mounted at /data gets tarred, gzipped and uploaded to a S3 bucket. Afterwards the archive gets deleted from the container. The mounted volume, of course, will be left untouched.
Expand Down

0 comments on commit ace36e7

Please sign in to comment.