carpet200/mongo-backup

Mongo Backup 镜像文档

镜像概述和主要用途

Mongo Backup是一个MongoDB备份应用，可使用任何mongotool命令。默认每天执行一次备份并存储为.tar.gz文件，支持通过命令恢复备份。该应用设计用于与MongoDB通过Docker Compose捆绑部署，简化MongoDB数据的备份与恢复流程。

核心功能和特性

• 定时备份：默认每天执行一次备份，支持通过cron表达式自定义备份时间
• 备份存储：将备份数据保存为.tar.gz格式文件
• 自动清理：可配置自动删除指定天数前的旧备份（0表示不删除）
• 启动时备份：支持在应用启动时立即执行一次备份
• 命令支持：提供多种命令用于手动备份、恢复、清理、查看备份列表等操作
• 无需安装mongotools：内置mongotool命令支持，无需额外安装

使用场景和适用范围

• 需要定期备份MongoDB数据的Docker环境
• 使用Docker Compose部署MongoDB的应用场景
• 需要简化MongoDB备份与恢复操作的开发或运维场景
• 适用于MongoDB 4.4.16版本，可能兼容更高版本

环境变量配置

通过.env文件设置以下环境变量：

# 备份的应用名称
APP_NAME="host_app"
# 时区设置
TIME_ZONE="Europe/Stockholm"

# MongoDB连接配置
# mongo - 用于连接Docker网络中名为mongo的容器
# host.docker.internal - 用于连接主机上的MongoDB
MONGO_IP='mongo'
MONGO_PORT=27017
MONGO_DB_NAME='database'    # 若未指定，将备份和恢复整个数据库

# MongoDB认证信息
MONGO_USERNAME=''
MONGO_PASSWORD=''

# 备份存储配置
BACKUP_FOLDER='./backups/'
# cron格式 - 分 时 日 月 年（默认每天凌晨3点）
BACKUP_TIME='0 3 * * *'
# 是否在启动时执行备份（true或false）
BACKUP_AT_STARTUP="true"
# 备份文件保留天数（0表示不删除）
BACKUP_REMOVE_AFTER_DAYS=60

Docker Compose配置

以下是使用Docker Compose部署的示例配置：

yaml
version: '3.4'

services:
    # 其他服务（如你的应用和MongoDB）
    # my-app:
    # mongo:

    mongo-backup:
        image: docker.xuanyuan.run/carpet200/mongo-backup:latest
        restart: unless-stopped
        volumes:
            - '${BACKUP_FOLDER}${APP_NAME}:/app/backups'

        # 如需访问主机上的MongoDB（不需要时可注释）
        extra_hosts:
           - 'host.docker.internal:host-gateway'

        environment:
            APP_NAME: ${APP_NAME}
            TZ: ${TIME_ZONE}
            MONGO_IP: ${MONGO_IP}
            MONGO_PORT: ${MONGO_PORT}
            MONGO_USERNAME: ${MONGO_USERNAME}
            MONGO_PASSWORD: ${MONGO_PASSWORD}
            MONGO_DB_NAME: ${MONGO_DB_NAME}
            BACKUP_TIME: ${BACKUP_TIME}
            BACKUP_AT_STARTUP: ${BACKUP_AT_STARTUP}
            BACKUP_REMOVE_AFTER_DAYS: ${BACKUP_REMOVE_AFTER_DAYS}

命令使用指南

通过容器执行命令，无需重复指定数据库密码和IP等信息。使用以下格式运行命令：

bash
docker exec {容器名称} node {命令} [参数]

可用命令列表

• backup - 在备份文件夹中创建.tar.gz备份文件
• clean - 删除超过指定天数的备份
• cmd - 使用任意mongotool命令
• help - 显示命令帮助信息
• info - 显示应用信息
• list - 列出所有备份文件
• restore - 从备份文件夹中的指定文件恢复数据库

提示：在任何命令后添加-help可获取该命令的详细帮助

命令详细说明

backup（创建备份）

创建.tar.gz格式的备份文件到备份文件夹：

bash
docker exec mongo-backup-1 node backup

restore（恢复备份）

从备份文件夹中的指定.tar.gz文件恢复数据库。使用--drop参数可清空现有数据后恢复，否则将合并数据：

bash
# 基本用法
docker exec mongo-backup-1 node restore {完整文件名} [可选的mongorestore参数]

# 示例：恢复并清空现有数据
docker exec mongo-backup-1 node restore MyApp_Backup.tar.gz --drop

cmd（执行mongotool命令）

使用任意mongotool命令，无需手动指定数据库认证信息：

bash
# 基本用法
docker exec mongo-backup-1 node cmd {mongotool工具} [工具参数]

# 示例1：查看mongorestore帮助
docker exec mongo-backup-1 node cmd mongorestore --help

# 示例2：从.bson文件文件夹恢复
docker exec mongo-backup-1 node cmd mongorestore ./bson-backup-2 --drop

手动操作示例（不使用本应用）

若不使用本应用，可通过以下命令手动备份和恢复MongoDB（需安装https://www.mongodb.com/try/download/database-tools%EF%BC%89%EF%BC%9A

bash
# 创建备份
mongodump -u "user" -p "password" mongodb://localhost:27017/mydb?authSource=admin --gzip --archive=dump.tar.gz

# 恢复备份
mongorestore -u "user" -p "password" mongodb://localhost:27017/mydb?authSource=admin --gzip --archive=dump.tar.gz