joch/s3backup

S3Backup

S3Backup是一个Docker容器，通过s3cmd sync工具将一个或多个文件夹备份到S3存储。

镜像概述

该容器用于实现文件夹到S3的定期备份，支持通过环境变量灵活配置备份参数和计划，适用于个人或企业的文件备份场景。

核心功能

1. 支持同时备份多个文件夹（需挂载到容器内/data目录）
2. 通过环境变量配置AWS访问密钥、S3路径及自定义参数
3. 支持CRON表达式自定义备份频率（默认每小时一次）

使用场景

• 个人文档、照片等文件的定期云端备份
• 小型项目数据的自动化S3存储备份
• 需要定时同步到S3的静态资源备份

配置说明

启动容器时需设置以下环境变量：

• ACCESS_KEY：AWS访问密钥
• SECRET_KEY：AWS秘密密钥
• S3PATH：目标S3桶及路径（格式：s3://bucket-name/path/）
• S3CMDPARAMS：s3cmd工具的自定义参数（可选）
• CRON_SCHEDULE：备份计划的CRON表达式（默认值：0 * * * *，即每小时一次）

部署示例

若需备份用户主目录下的Documents和Photos文件夹，并设置每天03:00执行备份，可使用以下命令：

docker run -d \
  -v /home/user/Documents:/data/documents:ro \
  -v /home/user/Photos:/data/photos:ro \
  -e "ACCESS_KEY=你的AWS访问密钥" \
  -e "SECRET_KEY=你的AWS秘密密钥" \
  -e "S3PATH=s3://你的S3桶名称/" \
  -e "CRON_SCHEDULE=0 3 * * *" \
  docker.xuanyuan.run/joch/s3backup

注：将命令中的占位符替换为实际的密钥、桶名称及路径即可使用。