psychomantys/database-backup

database-backup 镜像文档

镜像概述

database-backup 镜像是一款用于定期备份数据库的工具，基于 https://hub.docker.com/r/prodrigestivill/docker-postgres-backup-local/ 的设计理念开发。支持 linux/amd64、linux/arm64、linux/arm/v7 等Docker架构，可备份多种数据库类型并灵活配置存储方式。

核心功能与特性

• 多数据库支持：兼容 MariaDB、MongoDB、MySQL、PostgreSQL、OpenLDAP 等多种数据库类型
• 灵活的备份策略：可配置日、周、月级别的备份保留数量，自动清理过期备份
• 存储多样化：支持本地文件系统备份，或通过S3协议存储至对象存储（如AWS S3、MinIO）
• 自定义调度：通过Cron表达式设置自动备份时间，支持手动触发即时备份
• 空间优化：本地备份使用硬链接技术减少重复存储，节省磁盘空间
• 丰富配置：支持数据库连接参数、备份文件名、压缩参数等自定义配置

使用场景

适用于需要定期备份数据库的各类环境，包括：

• 生产环境数据库的自动化备份与长期归档
• 开发/测试环境的定期数据快照
• 需要将备份数据存储至本地磁盘或S3类对象存储的场景
• 需自定义备份频率和保留策略的业务系统

使用方法

基本使用要求

需挂载数据库数据目录至容器，配置环境变量，并挂载备份存储目录（本地或通过S3配置）。

Docker 命令示例

sh
docker run -v ${DB_BACKUP_OUT}:/data \
  -e DB_BACKUP_KEEP_DAYS=7 \
  -e DB_BACKUP_KEEP_WEEKS=4 \
  -e DB_BACKUP_KEEP_MONTHS=6 \
  -e "DB_USER=${DB_USER}" \
  -e "DB_PASSWORD=${DB_PASSWORD}" \
  -e DB_HOST=${DB_HOST} \
  -e DB_PORT=${DB_PORT} \
  psychomantys/database-backup

Docker Compose 配置示例

yaml
version: '3.9'
services:
  app-db:
    image: mariadb
    environment:
      MYSQL_RANDOM_ROOT_PASSWORD: "yes"
      MYSQL_DATABASE: ${DB_NAME}
      MYSQL_USER: ${DB_USER}
      MYSQL_PASSWORD: ${DB_PASSWORD}
      MYSQL_TCP_PORT: ${DB_PORT}
    volumes:
      - app_db_data:/var/lib/mysql

  app-backup-db:
    image: psychomantys/database-backup:latest
    environment:
      DB_TYPE: "maria"
      DB_BACKUP_KEEP_DAYS: 7
      DB_BACKUP_KEEP_WEEKS: 4
      DB_BACKUP_KEEP_MONTHS: 12
      DB_BACKUP_SCHEDULE: "00    03       *       *       *       "
      DB_NAMES: ${DB_NAME}
      DB_USER: ${DB_USER}
      DB_PASSWORD: ${DB_PASSWORD}
      DB_HOST: ${DB_HOST}
      DB_PORT: ${DB_PORT}
    volumes:
      - type: bind
        source: /home/app/backup/mariadb/
        target: /data

volumes:
  app_db_data:

环境变量配置

核心配置变量

S3/对象存储配置变量

手动触发备份

默认备份任务每日按DB_BACKUP_SCHEDULE配置执行，也可通过以下命令手动触发：

sh
docker exec -it "${CONTAINER}" /backup_database.sh start

其中${CONTAINER}为容器名称或ID。

自动定期备份配置

通过修改DB_BACKUP_SCHEDULE环境变量自定义备份频率，格式为Cron表达式（分 时 日 月 周）。例如：

• 00 02 * * * 表示每日凌晨2点执行
• 00 03 * * 0 表示每周日凌晨3点执行

Cron表达式语法可参考 cron.guru。

本地备份时，会自动创建daily、weekly、monthly目录，并通过硬链接存储备份文件以节省磁盘空间；使用S3流式备份时，本地不存储文件。

备份恢复示例

以下为恢复备份的常用方法。

恢复至远程服务器

按Docker Compose示例配置容器后，执行以下命令恢复指定备份文件（替换${BACKUP_FILENAME}为备份文件名，${CONTAINER}为容器名称）：

sh
docker exec -ti "${CONTAINER}" db_restore "${BACKUP_FILENAME}"

示例：

sh
docker exec -ti mysql-backup_app-backup-db_1 db_restore "/data/daily/opa-2020-10-31-02:20:00.sql.xz"

注意：部分数据库类型可能不支持db_restore命令，需根据实际数据库类型使用相应的恢复工具。

内置软件版本