diff --git a/README.md b/README.md new file mode 100644 index 0000000..ca94216 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Server backup + +This Docker image contains a simple script and a cron job to automate backups. For example, to periodically backup directories on a VPS. + +The container needs to be able to mount a volume that is as least as high as the most common path ancestor amongst your target backup directories. For example, all of my directories to backup are contained inside `~/myusername` and so I use that as the volume mount below. + +## Building the image + +Once the repo has been cloned locally, simply run `docker build -t backup .` to build the image. + +## Running the image container + +Pass the required environment variables to the container to run it. For example: + +``` +docker run -d --restart always \ + -v "/home/myusername:/backup" \ + -e "BUCKET=" \ + -e "ENDPOINT=https://s3.eu-central-003.backblazeb2.com" \ + -e "AWS_ACCESS_KEY_ID=" \ + -e "AWS_SECRET_ACCESS_KEY=" \ + -e "BACKUP_DIRS=folder1 folder2 folder3" \ + backup:latest +```