istepanov/backup-to-s3

istepanov/backup-to-s3

![Layers]([***]

镜像概述

这是一个使用s3cmd sync和cron定时任务，将文件定期备份到Amazon S3的Docker容器。

核心功能

1. 定期自动备份文件到Amazon S3
2. 支持单次备份、恢复S3文件到本地、删除S3上的备份文件
3. 可自定义备份参数、数据路径和定时规则

使用场景

• 日常数据自动备份到云端
• 一次性数据迁移到Amazon S3
• 从S3恢复备份文件到本地
• 清理S3上的旧备份文件

配置说明

基础使用命令

bash
docker run -d [OPTIONS] istepanov/backup-to-s3

必选参数

• -e ACCESS_KEY=<AWS密钥>：你的AWS访问密钥
• -e SECRET_KEY=<AWS密钥>：你的AWS秘密密钥
• -e S3_PATH=s3://<桶名>/<路径>/：S3桶名称和路径（需以斜杠结尾）
• -v /本地路径:/data:ro：挂载本地目标文件夹到容器的/data目录（只读模式）

可选参数

• -e PARAMS="--dry-run"：传递给sync命令的参数（完整列表）
• -e DATA_PATH=/data/：容器内的数据目录（默认值为/data/，需以斜杠结尾）
• -e 'CRON_SCHEDULE=0 1 * * *'：定时任务规则（默认每天凌晨1点执行，cron语法详情）
• no-cron：仅运行一次后退出（不启用定时任务）
• get：从S3恢复文件到本地
• delete：删除S3上的备份文件

示例

每天中午12点自动备份

bash
docker run -d \
    -e ACCESS_KEY=我的AWS密钥 \
    -e SECRET_KEY=我的AWS秘密密钥 \
    -e S3_PATH=s3://我的桶名/备份路径/ \
    -e 'CRON_SCHEDULE=0 12 * * *' \
    -v /home/user/数据:/data:ro \
    istepanov/backup-to-s3

单次备份后删除容器

bash
docker run --rm \
    -e ACCESS_KEY=我的AWS密钥 \
    -e SECRET_KEY=我的AWS秘密密钥 \
    -e S3_PATH=s3://我的桶名/备份路径/ \
    -v /home/user/数据:/data:ro \
    istepanov/backup-to-s3 no-cron

从S3恢复文件到本地

bash
docker run --rm \
    -e ACCESS_KEY=我的AWS密钥 \
    -e SECRET_KEY=我的AWS秘密密钥 \
    -e S3_PATH=s3://我的桶名/备份路径/ \
    -v /home/user/恢复目录:/data:rw \
    istepanov/backup-to-s3 get

删除S3上的备份文件

bash
docker run --rm \
    -e ACCESS_KEY=我的AWS密钥 \
    -e SECRET_KEY=我的AWS秘密密钥 \
    -e S3_PATH=s3://我的桶名/备份路径/ \
    istepanov/backup-to-s3 delete

安全注意事项

恢复文件时，容器会将恢复文件的权限设置为广泛开放状态，需注意权限管理。