christophetd/duplicacy-autobackup

Duplicacy Autobackup

https://travis-ci.org/christophetd/duplicacy-autobackup.svg?branch=master](https://travis-ci.org/christophetd/duplicacy-autobackup) https://images.microbadger.com/badges/image/christophetd/duplicacy-autobackup.svg](https://microbadger.com/images/christophetd/duplicacy-autobackup "获取自己的镜像徽章")

Duplicacy Autobackup是一个用于轻松执行自动化备份的Docker镜像。它基于https://github.com/gilbertchen/duplicacy%E6%9E%84%E5%BB%BA%EF%BC%8C%E5%9B%A0%E6%AD%A4%E6%94%AF%E6%8C%81%EF%BC%9A

• 多种存储后端：S3、Backblaze B2、Hubic、Dropbox、SFTP等
• 客户端加密
• 数据去重
• 多版本管理
• 以及duplicacy的其他所有功能

核心功能和特性

• 自动化备份：通过Cron-like调度策略实现定期自动备份
• 多存储支持：兼容主流云存储和本地存储协议
• 安全加密：支持客户端加密保护备份数据
• 高效存储：通过去重技术减少存储空间占用
• 灵活配置：支持备份前后执行自定义脚本，满足复杂场景需求

使用场景和适用范围

适用于需要定期备份数据的个人用户和企业环境，尤其适合：

• 服务器数据定时备份
• 数据库文件保护
• 重要文档和媒体文件的异地备份
• 需要加密和多版本管理的敏感数据备份

使用方法和配置说明

环境变量配置

以下环境变量用于配置备份策略：

• BACKUP_NAME：备份名称（应唯一，例如prod-db-backups）
• BACKUP_ENCRYPTION_KEY：可选的加密密码，用于在远程存储前加密备份
• BACKUP_SCHEDULE：Cron格式的调度字符串，定义备份频率（例如0 2 * * *表示每天UTC时间2点执行）
• BACKUP_LOCATION：https://github.com/gilbertchen/duplicacy/wiki/Storage-Backends%E6%A0%BC%E5%BC%8F%E7%9A%84%E5%A4%87%E4%BB%BD%E5%AD%98%E5%82%A8%E4%BD%8D%E7%BD%AE
  • S3：s3://region@amazon.com/bucket/path/to/storage
  • Backblaze B2：b2://my-bucket/
  • 其他存储后端请参考Duplicacy文档

存储提供商凭据

需为所选存储提供商提供凭据，通过以下环境变量：

• AWS S3：AWS_ACCESS_KEY_ID 和 AWS_SECRET_KEY
• Backblaze B2：B2_ID 和 B2_KEY
• Dropbox：DROPBOX_TOKEN
• Azure：AZURE_KEY
• Google Cloud Datastore：GCD_TOKEN
• SSH/SFTP：SSH_PASSWORD 或 SSH_KEY_FILE*
• Hubic：HUBIC_TOKEN_FILE*
• Google Cloud Storage：GCS_TOKEN_FILE*
• Onedrive：ONEDRIVE_TOKEN_FILE*

注意：标有*的环境变量指向文件，这些文件必须挂载到容器中才能被访问。

数据卷挂载

需要将待备份目录挂载到容器的/data路径。

即时备份执行

如需执行计划外备份，可在容器内运行脚本：

bash
$ docker exec duplicacy-autobackup /app/duplicacy-autobackup.sh backup

Docker部署示例

基本示例

将/var/lib/mysql目录备份到AWS S3的xtof-db-backups桶（eu-west-1区域），每天UTC时间2点执行，使用密码correct horse battery staple加密：

bash
$ docker run -d --name duplicacy-autobackup \
    -v /var/lib/mysql:/data \
    -e BACKUP_NAME='prod-db-backups' \
    -e BACKUP_LOCATION='s3://eu-west-1@amazon.com/xtof-db-backups' \
    -e BACKUP_SCHEDULE='0 2 * * *' \
    -e BACKUP_ENCRYPTION_KEY='correct horse battery staple' \
    -e AWS_ACCESS_KEY_ID='AKIA...' \
    -e AWS_SECRET_KEY='...' \
    christophetd/duplicacy-autobackup

备份查看与恢复

备份只有能成功恢复才有价值。以下是查看文件、版本和恢复备份的步骤：

准备工作

1. 安装Duplicacy：从https://github.com/gilbertchen/duplicacy/releases%E4%B8%8B%E8%BD%BD%E6%9C%80%E6%96%B0%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%E5%B9%B6%E6%B7%BB%E5%8A%A0%E5%88%B0PATH

2. 进入恢复目录，例如/tmp/restore：

   bash
   cd /tmp/restore
   

初始化存储

运行duplicacy init backup_name backup_location，其中backup_name和backup_location对应配置中的环境变量：

• 如果使用客户端加密，添加-encrypt标志：

  bash
  duplicacy init -encrypt backup_name backup_location
  

系统会提示输入存储提供商凭据和加密密钥（如适用）：

Enter S3 Access Key ID: *****
Enter S3 Secret Access Key: *************
Enter storage password for s3://eu-west-1@amazon.com/xtof-db-backups:*******************
The storage 's3://eu-west-1@amazon.com/xtof-db-backups' has already been initialized
Compression level: 100
Average chunk size: 4194304
Maximum chunk size: 16777216
Minimum chunk size: 1048576
Chunk seed: fc7e56fb91f8f66b01ba033ec6f7b128bcb3420c66a31468a4f3541407d569bd
/tmp/restore will be backed up to s3://eu-west-1@amazon.com/xtof-db-backups with id db-backups

查看备份版本

bash
$ duplicacy list
Storage set to s3://eu-west-1@amazon.com/xtof-db-backups
Enter storage password:*******************
Snapshot db-backups revision 1 created at 2018-04-19 09:47 -hash
Snapshot db-backups revision 2 created at 2018-04-19 09:48 
Snapshot db-backups revision 3 created at 2018-04-19 09:49 

查看特定版本文件

bash
$ duplicacy list -files -r 2  # 2是版本号

恢复文件

• 恢复版本2中所有匹配*.txt的文件到当前目录：

  bash
  $ duplicacy restore -r 2 '*.txt'
  

• 恢复版本2的所有文件到当前目录：

  bash
  $ duplicacy restore -r 2
  

更多操作请参考https://github.com/gilbertchen/duplicacy/wiki%E3%80%82

高级配置选项

备份前后脚本

可通过挂载脚本到/scripts/pre-backup.sh和/scripts/post-backup.sh，在备份前后执行自定义操作。例如，备份MySQL数据库前执行mysqldump。如果pre-backup.sh退出码非零，备份将推迟到下一次计划时间。

自定义Duplicacy行为

通过以下环境变量自定义Duplicacy行为：

• BACKUP_IMMEDIATLY (yes/no)：容器启动后是否立即执行备份，默认为no
• DUPLICACY_INIT_OPTIONS：首次备份时传递给duplicacy init的选项，默认当BACKUP_ENCRYPTION_KEY非空时为-encrypt
• DUPLICACY_BACKUP_OPTIONS：执行备份时传递给duplicacy backup的选项，默认为-threads 4 -stats。如果备份机械硬盘（非SSD），建议使用-threads 1 -stats（详见这里）

免责声明

本项目使用https://github.com/gilbertchen/duplicacy%EF%BC%8C%E4%B8%AA%E4%BA%BA%E4%BD%BF%E7%94%A8%E5%85%8D%E8%B4%B9%EF%BC%8C%E4%BD%86%E9%9D%9E%E8%AF%95%E7%94%A8%E5%95%86%E4%B8%9A%E7%94%A8%E9%80%94%E9%9C%80%E8%B4%AD%E4%B9%B0%E8%AE%B8%E5%8F%AF%E3%80%82%E8%AF%A6%E7%BB%86%E6%9D%A1%E6%AC%BE%E8%A7%81https://github.com/gilbertchen/duplicacy/blob/master/LICENSE.md%E3%80%82

联系信息

如有建议或 bug，请https://github.com/christophetd/duplicacy-autobackup/issues/new%EF%BC%8C%E6%88%96%E9%80%9A%E8%BF%87***%E8%81%94%E7%B3%BB@christophetd%E3%80%82