theorangeone/git-mirror

Git Mirror 镜像文档

概述

Git Mirror是一个用于在不同服务之间镜像Git仓库的工具，支持通过配置文件定义源和目标仓库，自动处理环境变量注入，实现增量同步以提高效率，并提供定期检查机制确保仓库内容实时一致。

核心功能和特性

• 配置驱动：通过repositories.toml配置文件定义需要镜像的仓库对，支持多仓库配置
• 环境变量注入：自动将环境变量注入到源和目标仓库URL中，便于敏感信息（如访问令牌）管理
• 增量同步：存储克隆的仓库，仅同步变更内容，减少网络和存储开销
• 自动优化：自动执行git gc命令，优化仓库存储大小
• 健康检查：支持配置HTTP心跳URL，定期检查进程运行状态（与healthchecks.io等服务兼容）
• 自定义存储：可指定仓库存储根目录，默认使用当前工作目录下的repositories/
• 灵活调度：可配置仓库检查间隔（默认15分钟），支持单次运行模式

使用场景和适用范围

• 仓库备份：将重要代码仓库镜像到备份服务（如从GitHub镜像到GitLab或私有仓库）
• 多平台同步：在不同代码托管平台间保持仓库内容一致（如同时维护GitHub和Gitee仓库）
• 自动化镜像维护：定期自动同步仓库变更，减少手动操作
• CI/CD辅助：为构建系统提供本地镜像仓库，加速依赖拉取

使用方法和配置说明

配置文件

通过repositories.toml文件定义需要镜像的仓库。配置示例：

toml
[[repository]]
source = "https://$GITHUB_TOKEN@github.com/RealOrangeOne/git-mirror"
destination = "https://$GITHUB_TOKEN@github.com/RealOrangeOne-backup/git-mirror"

全局配置（可选）

在repositories.toml中可添加全局设置：

toml
heartbeat = "https://hc-ping.com/your-uuid"  # 心跳检查URL
clone_root = "/data/repositories"  # 仓库存储目录
interval = 900  # 检查间隔（秒），默认900秒（15分钟）

环境变量

• GITHUB_TOKEN（示例）：用于源/目标仓库认证的访问令牌，会自动注入到配置文件的URL中
• 其他自定义环境变量：根据配置文件中的变量引用进行设置

运行方式

单次镜像同步

bash
docker run -v $(pwd)/repositories.toml:/app/repositories.toml -e GITHUB_TOKEN=your_token git-mirror --once

定期镜像同步（默认模式）

bash
docker run -d -v $(pwd)/repositories.toml:/app/repositories.toml -v $(pwd)/repositories:/app/repositories -e GITHUB_TOKEN=your_token git-mirror

Docker Compose 配置示例

yaml
version: '3'
services:
  git-mirror:
    image: git-mirror
    volumes:
      - ./repositories.toml:/app/repositories.toml
      - ./repositories:/app/repositories
    environment:
      - GITHUB_TOKEN=your_token
      - TZ=Asia/Shanghai
    restart: unless-stopped

配置参数说明