Sign inSign up

skymatic/s3backup

By skymatic

•Updated about 3 years ago

Backup Directory Contents to S3

Image
1

1.8K

skymatic/s3backup repository overview

⁠Manual Backup

To backup contents of your current working directory:

docker run --rm -v $(pwd):/backups -e "AWS_ACCESS_KEY_ID=..." -e "AWS_SECRET_ACCESS_KEY=.../" -e "AWS_S3_BUCKET_PATH=s3://my-bucket/" skymatic/s3backup

⁠Manual Restore

To restore a backup, run the restore script interactively (note the -it):

docker run -it --rm -v $(pwd):/backups -e "AWS_ACCESS_KEY_ID=..." -e "AWS_SECRET_ACCESS_KEY=.../" -e "AWS_S3_BUCKET_PATH=s3://my-bucket/" skymatic/s3backup ./restore.sh

⁠Scheduled Backup

Use compose to schedule backups to run daily⁠:

version: '3.2'
services:
  # ...
  backups:
    image: skymatic/s3backup
    environment:
      - AWS_ACCESS_KEY_ID=...
      - AWS_SECRET_ACCESS_KEY=...
      - AWS_S3_BUCKET_PATH=s3://my-bucket/
    volumes:
      - /very/important/files:/backups
    deploy:
      restart_policy:
        delay: 1d # run daily

⁠Customize Settings

Environment VariableDefault ValueComment
BACKUP_DIRECTORY/backupsDirectory containing the files to upload.
BACKUP_FILE_GLOB*Backup only specific files of your backup dir, e.g. *.tar.gz
OPENSSL_ENC_PASSSet to non-null value to encrypt file before uploading
AWS_DEFAULT_REGIONeu-central-1Specify region
AWS_STORAGE_CLASSREDUCED_REDUNDANCYSpecify storage class
AWS_ACCESS_KEY_IDThe API key id of your AWS user
AWS_SECRET_ACCESS_KEYThe API key of your AWS user

⁠Bucket-Credentials

Create an AWS IAM user and grant the following privileges for your bucket objects (e.g. arn:aws:s3:::my-bucket/*):

  • s3:PutObject

For restoring you also need the following permissions on your bucket and bucket objects (e.g. arn:aws:s3:::my-bucket and arn:aws:s3:::my-bucket/*):

  • s3:GetObject
  • s3:ListBucket

Tag summary

Content type

Image

Digest

sha256:f47878d25…

Size

38.6 MB

Last updated

about 3 years ago

docker pull skymatic/s3backup