docker-volume-backup

镜像概述和主要用途

offen/docker-volume-backup 是一个轻量级（小于15MB）的Docker辅助容器，用于为现有Docker环境提供定期或一次性的Docker卷备份功能。它支持将备份存储到本地目录、S3、WebDAV、Azure Blob Storage、Dropbox或SSH兼容存储（或多种组合），并可配置自动轮换旧备份。此外，还支持通过GPG加密备份及发送（失败）备份运行通知。

文档可在<[***]>查看：

• 快速入门
• 配置参考
• 操作指南
• 使用示例

核心功能和特性

• 轻量级设计：镜像体积小于15MB，资源占用低
• 多存储支持：备份可存储到本地目录或S3、WebDAV、Azure Blob Storage、Dropbox、SSH等兼容存储
• 备份轮换：可配置自动清理旧备份，节省存储空间
• GPG加密：支持对备份文件进行加密，保障数据安全
• 通知功能：可发送备份成功或失败的通知
• 容器停止支持：通过标签控制备份时停止相关容器，确保备份完整性
• 灵活部署：支持定期备份（compose集成）和一次性备份（Docker CLI）

使用场景和适用范围

• 生产环境中需要定期备份Docker卷数据的场景
• 需要将备份存储到多种存储介质（本地+云端）的场景
• 对数据安全性有要求，需加密备份的场景
• 需要确保备份数据完整性（需停止容器）的场景
• 一次性备份需求（如迁移前数据备份）

使用方法和配置说明

定期备份（Compose配置）

在现有Compose配置中添加backup服务，挂载需备份的卷：

yml
version: '3'

services:
  volume-consumer:
    build:
      context: ./my-app
    volumes:
      - data:/var/my-app
    labels:
      # 此标签表示备份期间将停止该容器以确保备份完整性
      # 若无需停止容器可省略此标签
      - docker-volume-backup.stop-during-backup=true

  backup:
    # 生产环境建议锁定镜像标签至具体版本，而非使用`latest`
    # 查看可用版本：[***]
    image: offen/docker-volume-backup:latest
    restart: always
    env_file: ./backup.env # 配置文件路径，详见下方说明
    volumes:
      - data:/backup/my-app-backup:ro
      # 挂载Docker socket允许脚本在备份期间停止/重启容器
      # 若无需停止容器可省略此挂载
      - /var/run/docker.sock:/var/run/docker.sock:ro
      # 挂载本地目录至/archive可保存本地备份
      # 可通过设置`BACKUP_ARCHIVE`覆盖容器内路径
      # 若无需本地备份可省略此挂载
      - /path/to/local_backups:/archive
volumes:
  data:

一次性备份（Docker CLI）

通过Docker CLI运行一次性备份，挂载需备份的卷并执行backup命令：

console
docker run --rm \
  -v data:/backup/data \
  --env AWS_ACCESS_KEY_ID="<xxx>" \
  --env AWS_SECRET_ACCESS_KEY="<xxx>" \
  --env AWS_S3_BUCKET_NAME="<xxx>" \
  --entrypoint backup \
  offen/docker-volume-backup:v2

也可通过--env-file传递完整配置文件，如上述Compose示例中的backup.env。