lobaro/restic-backup-docker

Restic备份Docker容器

这是一个用于自动化https://restic.github.io/%E7%9A%84Docker%E5%AE%B9%E5%99%A8%EF%BC%8C%E5%8F%AF%E5%AE%9A%E6%9C%9F%E6%89%A7%E8%A1%8C%E5%A4%87%E4%BB%BD%E4%BB%BB%E5%8A%A1%EF%BC%8C%E6%98%93%E4%BA%8E%E8%AE%BE%E7%BD%AE%E5%92%8C%E7%BB%B4%E6%8A%A4%EF%BC%8C%E6%94%AF%E6%8C%81%E5%A4%9A%E7%A7%8D%E5%AD%98%E5%82%A8%E7%9B%AE%E6%A0%87%EF%BC%88%E6%9C%AC%E5%9C%B0%E3%80%81NFS%E3%80%81SFTP%E3%80%81AWS S3等），并允许在容器内挂载备份文件进行浏览。

核心功能

• 定期自动化备份（通过Cron表达式配置执行频率）
• 支持多存储目标：本地目录、NFS、SFTP、AWS S3、OpenStack Swift、rclone后端
• 钩子脚本支持：备份前后执行自定义脚本（需挂载/hooks目录）
• 便捷的备份管理：手动执行备份、恢复数据、查看快照
• 通知集成：Microsoft Teams、邮件通知（备份结果推送）
• 详细日志记录：备份日志、错误日志、邮件通知日志

使用场景

• 服务器数据定期自动备份
• 云存储（如AWS S3、OpenStack Swift）的数据备份
• 本地文件/目录的自动化备份与管理
• 需要备份结果通知的业务场景

配置说明

环境变量

主要环境变量如下：

• RESTIC_REPOSITORY：restic仓库位置，默认/mnt/restic（S3示例：s3:https://s3.amazonaws.com/BUCKET_NAME）
• RESTIC_PASSWORD：仓库密码，首次启动时用于初始化仓库
• BACKUP_CRON：Cron表达式（UTC时间），默认0 */6 * * *（每6小时一次）
• RESTIC_FORGET_ARGS：备份后执行restic forget的参数（如--prune --keep-last 10）
• AWS_ACCESS_KEY_ID/AWS_SECRET_ACCESS_KEY：AWS S3存储的凭证
• TEAMS_WEBHOOK_URL：Microsoft Teams通知的Webhook地址
• MAILX_ARGS：邮件通知参数（需配置SMTP信息）

卷

• /data：需备份的数据目录，挂载宿主机目标路径（如-v /home/user/data:/data）
• /hooks：存放钩子脚本（pre-backup.sh/post-backup.sh），需挂载宿主机目录（如-v ~/hooks:/hooks）
• 日志卷：可选挂载/var/log以持久化日志（如-v ~/backup-logs:/var/log）

自定义主机名

通过--hostname参数设置容器主机名，确保restic快照中保存有意义的主机标识：

docker run --hostname my-server ...

SFTP备份

需无密码登录SFTP服务器，挂载宿主机.ssh目录到容器/root/.ssh：

docker run -v ~/.ssh:/root/.ssh ... -e RESTIC_REPOSITORY=sftp:user@host:/path/to/repo

OpenStack Swift备份

配置Swift相关环境变量，设置仓库路径为Swift容器：

docker run ... \
-e RESTIC_REPOSITORY=swift:backup:/ \
-e OS_AUTH_URL=https://auth.cloud.ovh.net/v3 \
-e OS_PROJECT_ID=xxxx \
-e OS_USERNAME=username \
-e OS_PASSWORD=password

rclone集成

挂载rclone配置文件到容器：

docker run -v /path/to/rclone.conf:/root/.config/rclone/rclone.conf ...

部署示例

拉取镜像

稳定版：

docker pull lobaro/restic-backup-docker:1.2-0.9.4

最新版（实验性）：

docker pull lobaro/restic-backup-docker:latest

运行容器

docker run -d \
--name restic-backup \
-v /home/user/data:/data \
-v /home/user/restic-repo:/mnt/restic \
-e RESTIC_PASSWORD="my_secure_password" \
-e BACKUP_CRON="0 0 * * *" \
lobaro/restic-backup-docker:1.2-0.9.4

手动操作

• 手动执行备份：docker exec -ti restic-backup /bin/backup
• 查看快照：docker exec -ti restic-backup restic snapshots
• 恢复数据（示例快照ID：abcdef12）：

  docker exec -ti restic-backup restic restore --include /data/docs --target / abcdef12
  

日志查看

• 查看Cron日志：docker logs restic-backup
• 查看最后一次备份日志：docker exec restic-backup cat /var/log/backup-last.log
• 查看错误日志：docker exec restic-backup cat /var/log/restic-error-last.log