maxisam/mgob

mgob

概述和主要用途

mgob是一个使用Go构建的MongoDB备份自动化工具。本项目是stefanprodan/mgob的分支版本，原作者计划归档该项目（https://github.com/stefanprodan/mgob/issues/161%EF%BC%89%EF%BC%8C%E5%9B%A0%E6%AD%A4%E4%BB%85%E5%9C%A8%E6%AD%A4%E5%88%86%E6%94%AF%E4%B8%AD%E6%8C%81%E7%BB%AD%E6%B7%BB%E5%8A%A0%E6%96%B0%E5%8A%9F%E8%83%BD%E3%80%82%E8%AF%A5%E5%B7%A5%E5%85%B7%E4%BB%A5Alpine Docker镜像形式分发，提供MongoDB备份的自动化管理能力。

核心功能和特性

本分支新增功能

• 备份验证功能
• 备份重试逻辑
• Microsoft Teams通知支持
• 使用github.com/jordan-wright/email处理邮件通知，解决证书问题（https://github.com/stefanprodan/mgob/issues/160%EF%BC%89
• 将Go版本更新至1.19
• 更新其他依赖项
• 为所有通知渠道添加warnOnly选项
• 使用GitHub Action进行CI/CD

原有功能

• 备份调度
• 本地备份保留策略
• 上传至S3对象存储（支持MinIO、AWS、Google Cloud、Azure）
• 上传至Google Cloud Storage
• 上传至SFTP服务器
• 上传至任何Rclone支持的存储服务
• 通知功能（邮件、Slack）
• Prometheus监控集成
• HTTP文件服务器（用于访问本地备份和日志）

使用场景和适用范围

适用于需要对MongoDB数据库进行自动化备份管理的场景，尤其适合以下用户：

• 需要定期调度MongoDB备份任务的团队或个人
• 要求备份具有验证机制和重试逻辑以确保可靠性的场景
• 需要将备份存储到多种位置（本地、S3、SFTP、Rclone支持的存储等）的用户
• 需要通过邮件、Slack或Microsoft Teams接收备份状态通知的组织
• 需要监控备份指标（如通过Prometheus）的运维团队

使用方法和配置说明

基本部署

mgob以Alpine Docker镜像形式分发，可通过Docker或Docker Compose部署。基本的docker run命令示例：

bash
docker run -d \
  --name mgob \
  -p 8080:8080 \
  -v /path/to/config:/config \
  -v /path/to/backups:/backups \
  maxisam/mgob

配置说明

配置文件通常位于/config目录下，采用YAML格式，包含备份任务的调度、存储设置、通知配置等。示例配置片段：

yaml
backups:
  - name: my-mongo
    schedule: "0 3 * * *"
    retention: 7
    mongodb:
      uri: "mongodb://user:pass@mongo:27017"
      database: "mydb"
    storage:
      s3:
        endpoint: "minio:9000"
        bucket: "backups"
        accessKey: "minio_access_key"
        secretKey: "minio_secret_key"
    notifications:
      teams:
        webhook: "https://outlook.office.com/webhook/..."
        warnOnly: false

关键配置参数

• 调度设置：通过schedule字段使用cron表达式定义备份频率
• 保留策略：retention字段指定本地备份保留天数
• 存储配置：根据目标存储类型（S3、SFTP、Rclone等）配置相应参数
• 通知配置：支持邮件、Slack、Teams等渠道，warnOnly选项控制是否仅警告级通知

详细配置说明请参考项目GitHub仓库文档。

监控与访问

• HTTP文件服务器：通过http://localhost:8080访问本地备份文件和日志
• Prometheus监控：指标端点位于http://localhost:8080/metrics，可配置Prometheus抓取