corfr/git-sync

git-sync镜像说明

镜像概述

git-sync是一款用于将远程Git仓库同步到本地并维护镜像的工具镜像，支持GitHub、Gerrit等多种源，可通过配置文件自定义同步规则，适用于项目镜像维护、减轻远程仓库负载等场景。

核心功能

1. 支持GitHub、Gerrit等多种远程源同步
2. 通过YAML配置文件灵活定义同步任务（包括目标路径、源地址、过滤规则等）
3. Gerrit源支持SSH协议、项目过滤（字符串/正则）及实时事件监听同步
4. 支持全局默认配置与单个源自定义配置的结合

使用场景

• 维护开源项目的本地镜像仓库
• 减轻远程仓库（如GitHub）的访问压力
• 本地缓存常用项目仓库以提升访问速度
• 批量同步多个Gerrit项目并过滤指定内容

配置说明

基础配置

需提供config.yml配置文件，示例结构如下：

yaml
global:
    to: '/storage/git'  # 全局默认同步目标路径
sources:
  - from: 'https://github.com/CoRfr/git-sync'  # GitHub源地址
  - from: 'https://github.com/CoRfr/ruby-git'
    to: '/mnt/external/ruby-git.git'  # 自定义目标路径
  - type: 'gerrit'  # Gerrit源类型
    host: 'gerrit-host'
    username: 'myuser'
    from: 'git://gerrit-mirror/'
    filters:  # 过滤规则（字符串或正则）
      - 'manifest'
      - '/meta.*/'

源类型说明

Single源（默认）

简单同步单个Git远程仓库到指定路径，若全局to存在则自动拼接路径：

yaml
- from: 'https://github.com/CoRfr/ruby-git'
  to: '/mnt/external/ruby-git.git'

Gerrit源

通过SSH协议同步Gerrit项目，支持过滤和实时监听：

yaml
- type: 'gerrit'
  host: 'gerrit-host'
  username: 'myuser'
  from: 'git://gerrit-mirror/'  # 可选镜像源地址
  filters: ['manifest', '/meta.*/']
  oneshot: true  # 可选，关闭实时监听（仅同步一次）

部署示例

Docker Run命令

bash
docker run -d \
  -v /本地配置路径/config.yml:/config.yml \
  -v /本地存储路径:/storage/git \
  corfr/git-sync /config.yml

Docker Compose示例

yaml
version: '3'
services:
  git-sync:
    image: corfr/git-sync
    volumes:
      - ./config.yml:/config.yml
      - ./git-storage:/storage/git
    command: /config.yml