melke / docker-backup-to-s3

Docker container that periodically backups files to Amazon S3 using s3cmd and cron

Docker Backup to Amazon S3

Docker container that periodically backs up files to Amazon S3 using s3cmd sync and cron.

This version was forked from https://github.com/istepanov/docker-backup-to-s3

Usage

docker run -d [OPTIONS] lamielle/backup-to-s3

Parameters:

• -e ACCESS_KEY=<AWS_KEY>: Your AWS key.
• -e SECRET_KEY=<AWS_SECRET>: Your AWS secret.
• -e S3_PATH=s3://<BUCKET_NAME>/<PATH>/: S3 Bucket name and path. Should end with trailing slash.
• -v /path/to/backup:/data:ro: mount target local folder to container's data folder. Content of this folder will be synced with S3 bucket.

Optional parameters:

• -e DATA_PATH=/data/: container's data folder. Default is /data/. Should end with trailing slash.
• -e 'CRON_SCHEDULE=0 1 * * *': specifies when cron job starts (details). Default is 0 1 * * * (runs every day at 1:00 am).
• no-cron: run container once and exit (no cron scheduling).

Examples:

Run sync to S3 everyday at 12:00pm:

docker run -d \
    -e ACCESS_KEY=myawskey \
    -e SECRET_KEY=myawssecret \
    -e S3_PATH=s3://my-bucket/backup/ \
    -e 'CRON_SCHEDULE=0 12 * * *' \
    -v /home/user/data:/data:ro \
    lamielle/backup-to-s3

Run tar + copy to S3 everyday at 12:00pm:

docker run -d \
    -e ACCESS_KEY=myawskey \
    -e SECRET_KEY=myawssecret \
    -e S3_PATH=s3://my-bucket/backup/ \
    -e 'CRON_SCHEDULE=0 12 * * *' \
    -v /home/user/data:/data:ro \
    lamielle/backup-to-s3 tar

Run once then delete the container:

docker run --rm \
    -e ACCESS_KEY=myawskey \
    -e SECRET_KEY=myawssecret \
    -e S3_PATH=s3://my-bucket/backup/ \
    -v /home/user/data:/data:ro \
    lamielle/backup-to-s3 no-cron