dokku/s3backup

docker-s3backup

概述

docker-s3backup是一个Docker镜像，用于将主机卷创建为tar备份并流式传输到Amazon S3存储。它具备轻量级、高效传输和广泛兼容性的特点，适用于需要将主机数据备份到S3或S3兼容存储服务的场景。

核心功能与特性

• 轻量级：基于Alpine基础镜像构建，镜像体积小，资源占用低
• 快速传输：通过awscli将备份直接流式传输到S3，减少中间存储环节，提升备份效率
• 广泛兼容：支持Amazon S3及自托管S3兼容服务（如minio），适应不同存储环境需求

使用场景与适用范围

适用于需要定期备份主机数据（如应用数据、配置文件、日志等）到Amazon S3的场景，尤其适合资源受限环境（轻量级特性）和使用自托管S3服务（如minio）的私有环境。

使用方法

基础使用

运行预构建镜像，需指定AWS凭证、S3存储桶名称和待备份路径：

shell
docker run -it \
      -e AWS_ACCESS_KEY_ID=你的AWS访问密钥ID \
      -e AWS_SECRET_ACCESS_KEY=你的AWS密钥 \
      -e BUCKET_NAME=存储桶名称 \
      -e BACKUP_NAME=备份名称前缀 \
      -v /本地需备份路径:/backup dokku/s3backup

参数说明：

• -e AWS_ACCESS_KEY_ID：AWS访问密钥ID，用于S3身份验证
• -e AWS_SECRET_ACCESS_KEY：AWS密钥，用于S3身份验证
• -e BUCKET_NAME：目标S3存储桶名称
• -e BACKUP_NAME：备份文件的名称前缀（最终备份文件名将包含时间戳）
• -v /本地需备份路径:/backup：挂载主机需备份的目录到容器内/backup路径（容器将备份此路径下的所有内容）

高级使用

支持自定义区域、存储类别、签名版本及S3兼容服务配置，示例如下：

shell
docker run -it \
      -e AWS_ACCESS_KEY_ID=你的AWS访问密钥ID \
      -e AWS_SECRET_ACCESS_KEY=你的AWS密钥 \
      -e AWS_DEFAULT_REGION=us-east-1 \
      -e AWS_SIGNATURE_VERSION=s3v4 \
      -e S3_STORAGE_CLASS=STANDARD_IA \
      -e ENDPOINT_URL=https://你的S3兼容服务API地址 \
      -e BUCKET_NAME=存储桶名称 \
      -e BACKUP_NAME=备份名称前缀 \
      -v /本地需备份路径:/backup dokku/s3backup

高级参数说明：

• AWS_DEFAULT_REGION：S3存储桶所在区域（默认：us-east-1）
• AWS_SIGNATURE_VERSION：S3签名版本（如s3v4）
• S3_STORAGE_CLASS：S3存储类别（如STANDARD_IA为低频访问存储）
• ENDPOINT_URL：S3兼容服务的API终端地址（自托管服务如minio时需指定）

加密备份

可通过GnuPG加密备份文件，需添加ENCRYPTION_KEY环境变量：

shell
docker run -it \
      -e AWS_ACCESS_KEY_ID=你的AWS访问密钥ID \
      -e AWS_SECRET_ACCESS_KEY=你的AWS密钥 \
      -e BUCKET_NAME=存储桶名称 \
      -e BACKUP_NAME=备份名称前缀 \
      -e ENCRYPTION_KEY=你的加密密码 \
      -v /本地需备份路径:/backup dokku/s3backup

构建镜像

如需自行构建镜像，步骤如下：

1. 构建镜像：

shell
docker build -t s3backup .

2. 运行自定义构建的镜像：

shell
docker run -it \
      -e AWS_ACCESS_KEY_ID=你的AWS访问密钥ID \
      -e AWS_SECRET_ACCESS_KEY=你的AWS密钥 \
      -e BUCKET_NAME=存储桶名称 \
      -e BACKUP_NAME=备份名称前缀 \
      -v /本地需备份路径:/backup s3backup