powaline/docker-aws-backup repository overview

⁠Backup data to AWS S3

This project provides Docker images to periodically back up compress, encrypt and transfer data folders to AWS S3, and to restore from the backup as needed.

⁠📦 Requirements

The Docker & Docker Compose system requirements are Linux Ubuntu as the OS (other operating systems are supported as well), an absolute minimum 512MB RAM (2GB recommended)

In order to install docker Ubuntu, you will need to meet the following requirements:

• OS: Linux Ubuntu
• Memory: 512MB RAM (2GB Recommended)
• Disk: Sufficient amount to run the Docker containers you wish to use
• CPU: Dependant on the applications you wish to run in the containers

⁠📋 Features

• The SCHEDULE variable determines backup frequency. See go-cron schedules documentation here⁠. Omit to run the backup immediately and then exit.
• If PASSPHRASE is provided, the backup will be encrypted using GPG.
• Run docker exec <container name> sh backup.sh to trigger a backup ad-hoc.
• If BACKUP_KEEP_DAYS is set, backups older than this many days will be deleted from S3.
• Set S3_ENDPOINT if you're using a non-AWS S3-compatible storage provider.

⁠🔧 Installation

1. Install Docker and Docker-Compose

• Docker Install documentation⁠
• Docker-Compose Install documentation⁠

1. Bring up your stack by running

git clone https://github.com/powaline/docker-aws-backup.git \
    && cd docker-aws-backup \
    && cp .env.example .env

1. Edit environment variable

# Backup
TZ=UTC
SCHEDULE=@weekly
BACKUP_FOLDER=
BACKUP_FILE_NAME=
BACKUP_KEEP_DAYS=7
PASSPHRASE=platonic-subdued-curvy-tweet-backroom
S3_BUCKET=my-s3-bucket
S3_REGION=us-east-1
S3_PREFIX=prefix
S3_ACCESS_KEY_ID=
S3_SECRET_ACCESS_KEY=

1. Start backup data to AWS S3

docker-compose up -d

⁠📝 Usage

Example compose.yaml

version: "3.9"

services:
  backup:
    container_name: data-backup
    restart: always
    image: powaline/docker-aws-backup:1.0.0
    environment:
      - TZ=${TZ:-UTC}
      - SCHEDULE=${SCHEDULE:-@weekly}
      - BACKUP_FOLDER=${BACKUP_FOLDER}
      - BACKUP_FILE_NAME=${BACKUP_FILE_NAME:-backup}
      - BACKUP_KEEP_DAYS=${BACKUP_KEEP_DAYS:-7}
      - PASSPHRASE=${PASSPHRASE:-passphrase}
      - S3_REGION=${S3_REGION:-region}
      - S3_BUCKET=${S3_BUCKET:-bucket}
      - S3_PREFIX=${S3_PREFIX:-prefix}
      - S3_ACCESS_KEY_ID=${S3_ACCESS_KEY_ID:-key}
      - S3_SECRET_ACCESS_KEY=${S3_SECRET_ACCESS_KEY:-secret}
    volumes:
      - ${BACKUP_FOLDER}:/home/backups
    networks:
      - powaline

networks:
  powaline:
    driver: bridge
    name: powaline

⁠Restore

⁠... from latest backup

docker exec <container name> sh restore.sh

⁠... from specific backup

docker exec <container name> sh restore.sh <timestamp>

⁠📨 Message

I hope you find this useful. If you have any questions, please create an issue.

⁠🔐 Security

If you discover any security related issues, please email [email protected]⁠ instead of using the issue tracker.

⁠📖 License

This software is released under the BSD 3-Clause⁠ License. Please see the LICENSE⁠ file or https://powaline.com/license⁠ for more information.

⁠✨ Contributors

Thanks goes to these wonderful people (emoji key⁠):

Son Tran Thanh ⁠ 💻⁠ 📝⁠

This project follows the all-contributors⁠ specification. Contributions of any kind welcome!