mysql-cron-backup Docker镜像文档

镜像概述

该Docker镜像通过cron任务管理器定期运行mysqldump工具备份MySQL/MariaDB数据库。备份文件默认存储在容器内的/backup目录，可通过Docker卷挂载将备份文件存储到主机指定路径，实现数据持久化。

核心功能与特性

• 定期自动备份：通过CRON_TIME参数自定义备份频率，默认每周日UTC时间03:00执行
• 备份管理：支持设置MAX_BACKUPS限制备份文件数量，自动清理旧备份
• 初始化操作：支持容器启动时立即执行备份（INIT_BACKUP）或恢复最新备份（INIT_RESTORE_LATEST）
• 备份压缩：通过GZIP_LEVEL参数控制gzip压缩级别（1-9），默认级别6
• 灵活配置：支持自定义mysqldump参数、数据库连接信息、时区等
• 兼容性：可与MySQL/MariaDB容器配合使用，支持通过docker-compose编排部署

使用场景

• 生产环境MySQL/MariaDB数据库定期自动备份
• 开发/测试环境数据库数据备份与快速恢复
• 需要控制备份频率、保留数量及压缩级别的场景
• 与Docker化MySQL服务配套部署的备份解决方案

使用方法

Docker Run命令示例

bash
docker container run -d \
       --env MYSQL_USER=root \
       --env MYSQL_PASS=my_password \
       --link mysql \
       --volume /path/to/my/backup/folder:/backup \
       fradelg/mysql-cron-backup

Docker Compose配置示例

以下示例展示如何与MariaDB容器配合使用，仅内部暴露3306端口，实现数据库备份功能：

yaml
version: "2"
services:
  mariadb:
    image: mariadb
    container_name: my_mariadb
    expose:
      - 3306
    volumes:
      - data:/var/lib/mysql
      # 若数据库无初始化 schema，恢复最新备份（如有）
      - ${VOLUME_PATH}/backup/latest.${DATABASE_NAME}.sql.gz:/docker-entrypoint-initdb.d/database.sql.gz
    environment:
      - MYSQL_ROOT_PASSWORD=${MARIADB_ROOT_PASSWORD}
      - MYSQL_DATABASE=${DATABASE_NAME}
    restart: unless-stopped

  mysql-cron-backup:
    image: fradelg/mysql-cron-backup
    depends_on:
      - mariadb
    volumes:
      - ${VOLUME_PATH}/backup:/backup
    environment:
      - MYSQL_HOST=my_mariadb
      - MYSQL_USER=root
      - MYSQL_PASS=${MARIADB_ROOT_PASSWORD}
      - MAX_BACKUPS=15
      - INIT_BACKUP=0
      # 每天UTC时间03:00执行备份
      - CRON_TIME=0 3 * * *
      # 最高压缩级别
      - GZIP_LEVEL=9
    restart: unless-stopped

volumes:
  data:

配置参数说明

备份恢复方法

查看备份文件

在运行的容器内列出所有备份文件：

bash
docker container exec <容器名称或ID> ls /backup

从备份恢复

恢复指定备份文件（替换<备份文件名>为实际备份文件名）：

bash
docker container exec <容器名称或ID> /restore.sh /backup/<备份文件名>

例如，恢复201708060500.my_db.sql.gz备份：

bash
docker container exec backup /restore.sh /backup/201708060500.my_db.sql.gz