uvoo/gitrepo-todir-sync

docker-gitrepo-todir-sync 镜像文档

镜像概述

docker-gitrepo-todir-sync是一个轻量级Docker容器，旨在简化Git仓库到本地目录的同步过程。它能够自动定期将指定的Git仓库克隆或拉取到本地目录，适用于需要保持本地代码库与远程仓库同步的场景。

核心功能和特性

• 多仓库支持：可同时配置并同步多个Git仓库
• 定时同步：支持自定义同步间隔，实现自动定期同步
• 协议兼容：支持HTTPS和SSH协议的Git仓库访问
• 自动目录管理：自动创建目标目录结构，无需手动配置
• 轻量级设计：基于精简基础镜像，资源占用低，部署便捷

使用场景和适用范围

• 静态网站生成：定期同步远程内容仓库到本地用于站点构建
• 代码备份：自动备份多个Git仓库到本地存储介质
• 开发环境同步：保持本地开发目录与远程仓库最新状态
• 配置管理：同步包含应用配置文件的Git仓库到本地服务

使用方法和配置说明

基本使用（docker run）

bash
docker run -d \
  -v /path/to/local/directory:/app/sync \
  -e REPO_URLS="https://github.com/example/repo1.git,git@github.com:example/repo2.git" \
  -e SYNC_INTERVAL="3600" \
  uvoo/gitrepo-todir-sync

环境变量配置

SSH协议仓库配置

对于使用SSH协议的Git仓库，需挂载SSH密钥到容器：

bash
docker run -d \
  -v /path/to/local/directory:/app/sync \
  -v /path/to/ssh/private/key:/root/.ssh/id_rsa \
  -v /path/to/ssh/known_hosts:/root/.ssh/known_hosts \
  -e REPO_URLS="git@github.com:example/private-repo.git" \
  -e SYNC_INTERVAL="1800" \
  uvoo/gitrepo-todir-sync

Docker Compose配置示例

yaml
version: '3'

services:
  git-sync:
    image: uvoo/gitrepo-todir-sync
    volumes:
      - ./local-sync-directory:/app/sync
      - ./ssh-keys:/root/.ssh  # 仅SSH仓库需要
    environment:
      - REPO_URLS=https://github.com/example/public-repo.git,git@github.com:example/private-repo.git
      - SYNC_INTERVAL=3600
      - GIT_USER_NAME=my-git-user
      - GIT_USER_EMAIL=my-git-user@example.com
    restart: unless-stopped

注意事项

• 确保挂载的本地目录具有正确的读写权限
• SSH密钥文件权限需设置为600（容器内）
• 首次同步会执行完整克隆，后续同步使用git pull更新
• HTTPS协议仓库可在URL中包含认证信息：https://user:token@github.com/example/repo.git
• 同步过程中会自动处理分支更新和冲突（默认采用git pull --rebase策略）