imixs/backup

imixs/backup

该Docker镜像提供备份服务，用于备份Docker卷中的PostgreSQL或MySQL数据库，可添加到包含PSQL或MySQL实例的Docker栈中实现周期性备份。同时支持备份挂载Docker卷中的可选文件，所有备份文件组织在备份目录中，并可选择性传输到备份空间。该服务设计用于备份单个数据库，如需备份整个PSQL或MySQL服务器，应使用pg_dumpall命令替代pg_dump（详见脚本backup.sh）。

核心功能与特性

• 备份PostgreSQL或MySQL数据库
• 备份Docker卷中的文件内容
• 支持通过SFTP/SCP将备份文件传输到外部备份空间
• 定时任务（Cron）支持
• 恢复功能

环境基础与变量

imixs/backup镜像基于https://hub.docker.com/_/postgres/%E6%9E%84%E5%BB%BA%EF%BC%8C%E5%B9%B6%E6%B7%BB%E5%8A%A0%E4%BA%86mariadb-client%E6%94%AF%E6%8C%81%E3%80%82%E5%90%AF%E5%8A%A8%E5%AE%B9%E5%99%A8%E6%97%B6%E9%9C%80%E8%AE%BE%E7%BD%AE%E4%BB%A5%E4%B8%8B%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%EF%BC%9A

• SETUP_CRON - Cron定时设置（例如："0 3 * * *"）
• BACKUP_SERVICE_NAME - 备份服务名称（定义备份空间上的目标文件夹）
• BACKUP_DB_HOST - 数据库服务器地址
• BACKUP_DB_USER - 数据库用户名
• BACKUP_DB_PASSWORD - 数据库用户密码
• BACKUP_DB_TYPE - 数据库类型，设为'MYSQL'或'POSTGRESQL'
• BACKUP_DB - PostgreSQL或MySQL数据库名称
• BACKUP_VOLUME - 可选，挂载Docker卷中的文件目录
• BACKUP_SPACE_HOST - 可选，通过SFTP/SCP连接的备份空间主机
• BACKUP_SPACE_USER - 可选，备份空间用户名
• BACKUP_LOCAL_ROLLING - 本地保留的备份文件数量
• BACKUP_SPACE_ROLLING - 备份空间保留的备份文件数量
• BACKUP_ROOT_DIR - 备份根目录（例如："/imixs-cloud"，默认值为"/imixs-cloud"）
• BACKUP_EMAIL_SMARTHOST - 可选，Exim智能主机服务的容器名称（可使用https://github.com/imixs/imixs-docker/blob/master/exim4/README.md%EF%BC%89
• BACKUP_EMAIL_FROM - 可选，备份成功邮件的发件人地址
• BACKUP_EMAIL_TO - 可选，备份成功邮件的收件人地址

所有本地备份文件位于：
/root/backups/

备份空间中的文件路径：
/$BACKUP_ROOT_DIR/$BACKUP_SERVICE_NAME/

每个备份文件名称前缀包含时间戳，格式如下：
2018-01-07_03:00_dump.tar.gz

定时任务（Cron）

基于环境变量SETUP_CRON提供的Cron设置，backup_init脚本会启动Cron任务以调度backup.sh脚本。

示例：

bash
# 每天凌晨3点执行
0 3 * * *

详情参见Cron使用说明。

脚本说明

所有备份脚本位于根目录（/root/）：

• backup_init.sh - 通过Cron初始化备份服务
• backup.sh - 备份执行脚本
• restore.sh - 恢复脚本
• backup_get.sh - 从远程备份空间获取文件

可手动调用脚本：

bash
$ docker exec -it 2f4b2feaa412 /root/backup.sh

滚动备份文件

备份脚本自动保留指定数量的本地备份文件，默认保留5个。可通过环境变量BACKUP_LOCAL_ROLLING修改该数量。

备份空间配置

若设置了可选环境变量BACKUP_SPACE_HOST，服务会通过SFTP/SCP自动将备份文件推送到备份空间。备份空间中的目录结构为：
/$BACKUP_ROOT_DIR/$BACKUP_SERVICE_NAME/....

可选环境变量BACKUP_SERVICE_NAME用于命名备份空间上的目录，若未设置，则使用Docker容器ID。BACKUP_ROOT_DIR用于指定备份空间的根目录，未设置时默认使用/imixs-cloud。

创建SSH密钥

为通过SFTP/SCP传输文件，需在备份空间上配置RFC4716格式的公钥。备份服务通过Docker Secret获取私钥文件（仅在Docker Swarm环境中可用）。

将私钥文件/root/.ssh/backupspace_rsa创建为Docker Secret：

bash
docker secret create backupspace_key /root/.ssh/backupspace_rsa

在Docker栈定义中引用该Secret：

yaml
version: '3.1'

services:
  backup:
    image: imixs/backup:latest
    environment:
      ...
      BACKUP_SPACE_KEY_FILE: "/run/secrets/backupspace_key"
    secrets:
      - backupspace_key
...
secrets:
  backupspace_key:
    external: true

备份成功邮件通知

若设置以下环境变量，备份脚本会发送成功执行邮件通知：

• BACKUP_EMAIL_SMARTHOST
• BACKUP_EMAIL_FROM
• BACKUP_EMAIL_TO

需提供智能主机服务名称（或IP）、发件人和收件人地址。详见https://github.com/imixs/imixs-docker/blob/master/exim4/README.md%E9%85%8D%E7%BD%AE%E8%AF%B4%E6%98%8E%E3%80%82

部署方法

imixs/backup服务通常作为Docker服务栈的一部分运行，需与PSQL/MySQL数据库服务及挂载卷在同一栈中，通过内部网络连接。

基本部署示例（备份WordPress）

以下示例配置用于备份包含MySQL数据库和wp-content卷的WordPress服务：

yaml
...
  backup:
    image: imixs/backup:1.2.1
    environment:
      SETUP_CRON: "0 4 * * *"
      BACKUP_SERVICE_NAME: "my-service"
      BACKUP_DB_USER: "wordpress_dms"
      BACKUP_DB_PASSWORD: "xxxxxxxxxxx"
      BACKUP_DB_HOST: "db"
      BACKUP_DB_TYPE: "MYSQL"
      BACKUP_DB: "wordpress"
      BACKUP_VOLUME: "/var/www/html/wp-content"
      BACKUP_LOCAL_ROLLING: "5"
    volumes: 
      - wp-content:/var/www/html/wp-content
    networks:
      - backend
...

添加备份空间配置

如需启用远程备份空间，添加以下环境变量：

yaml
...
      BACKUP_SERVICE_NAME: "my-app"
      BACKUP_SPACE_HOST: "my-backup.org"
      BACKUP_SPACE_USER: "yyyy"
      BACKUP_SPACE_KEY_FILE: "/run/secrets/backupspace_key"
      BACKUP_ROOT_DIR: "/imixs-cloud"
...

备份文件卷

如需备份挂载卷中的文件目录：

yaml
...
      BACKUP_VOLUME: "/home/imixs" 
    volumes: 
      - appdata:/home/imixs
...

启用邮件通知

添加以下环境变量启用备份成功邮件：

yaml
...
      BACKUP_EMAIL_SMARTHOST: "smarthost"
      BACKUP_EMAIL_FROM: "backupagent@yourcompany.com"
      BACKUP_EMAIL_TO: "sysadmin@yourcompany.com"
...

手动备份

可通过以下方式手动触发备份：

直接执行脚本

bash
$ docker exec -it 82526abbabfe /root/backup.sh  # 替换容器ID为实际备份服务ID

进入容器执行

bash
$ docker exec -it 82526abbabfe bash  # 替换容器ID
root@82526abbabfe:/# /root/backup.sh

列出本地备份

bash
ls -la /root/backups

恢复操作

备份服务提供恢复脚本，可通过以下方式执行（需替换容器ID）：

bash
docker exec -it 82526abbabfe [SCRIPT]

或进入容器后直接执行：

bash
docker exec -it 82526abbabfe bash

恢复本地备份文件

本地备份文件位于/root/backups/，文件名包含ISO格式时间戳。

列出本地备份

bash
ls -la /root/backups

恢复最新备份

bash
/root/restore.sh

恢复特定备份

指定备份文件的时间戳前缀：

bash
/root/restore.sh 2018-01-05_03:00

恢复远程备份文件

若本地无备份文件，可先从备份空间拉取：

列出远程备份文件

bash
echo ls -la /$BACKUP_ROOT_DIR/$BACKUP_SERVICE_NAME | sftp $BACKUP_SPACE_USER@$BACKUP_SPACE_HOST

拉取远程备份文件

bash
/root/backup_get.sh /$BACKUP_ROOT_DIR/$BACKUP_SERVICE_NAME/[BACKUPFILE]  # 替换[BACKUPFILE]为实际文件名

文件将保存到/root/backups/，之后可按本地恢复步骤操作。

贡献与开发

贡献代码

源码托管于https://github.com/imixs/imixs-docker%EF%BC%8C%E9%97%AE%E9%A2%98%E5%8F%8D%E9%A6%88%E8%AF%B7%E6%8F%90%E4%BA%A4%E8%87%B3https://github.com/imixs/imixs-docker/issues%E3%80%82

本地开发

构建镜像

bash
docker build --tag=imixs/backup .

交互式测试

bash
docker run --name="backup" -it --rm \
    -e SETUP_CRON="*/1 * * * *" \
    -e BACKUP_DB_PASSWORD="xxxxxxxxxxx" \
    -e BACKUP_DB_HOST="db" \
    -e BACKUP_DB_TYPE="POSTGRES" \
    -e BACKUP_DB="wordpress" \
    imixs/backup

上述命令将每分钟触发一次备份。