bringnow/git-sync

bringnow/git-sync镜像说明

镜像概述

该Docker镜像用于实现本地文件夹与Git仓库之间的自动同步，通过定时任务（Cron）定期将指定目录的内容同步到目标Git仓库，适用于需要持续更新代码或文件到版本控制系统的场景。

核心功能

• 支持Git仓库的同步操作（需配置正确权限）
• 可通过环境变量设置定时同步频率（Cron语法）
• 支持SSH密钥认证，确保仓库访问的安全性
• 提供本地目录覆盖选项，处理非空目录的初始同步问题

使用场景

• 持续集成/部署流程中，自动同步代码到远程仓库
• 静态资源（如网站内容）的定期更新与版本管理
• 多环境下的配置文件或数据文件同步

配置说明

环境变量

必填项

• GIT_REPO_URL: Git仓库地址，例如ssh://git@example.com/foo/bar.git
• GIT_REPO_BRANCH: 同步的分支名称，默认值为master
• GIT_USER_EMAIL: 提交时显示的作者***
• GIT_USER_NAME: 提交时显示的作者名称

可选项

• CRON_TIME: 定时同步的Cron表达式，默认值为*/1 * * * *（每分钟一次）
• OVERWRITE_LOCAL: 是否覆盖本地非空目录（未包含Git仓库时），值为true或false

卷挂载

• /root/.ssh: 存放SSH密钥（id_rsa、id_rsa.pub）及known_hosts文件，确保仓库访问权限
• /sync-dir: 需要同步的本地文件夹目录

部署示例

Docker Run命令

bash
docker run -d \
  -e GIT_REPO_URL=ssh://git@example.com/foo/bar.git \
  -e GIT_REPO_BRANCH=production \
  -e GIT_USER_EMAIL=user@example.com \
  -e GIT_USER_NAME="Your Name" \
  -e CRON_TIME="*/5 * * * *" \
  -v /host/path/to/ssh:/root/.ssh \
  -v /host/path/to/sync:/sync-dir \
  bringnow/git-sync

Docker Compose示例

yaml
version: '3'
services:
  git-sync:
    image: bringnow/git-sync
    environment:
      GIT_REPO_URL: ssh://***/foo/bar.git
      GIT_REPO_BRANCH: production
      GIT_USER_*** ***
      GIT_USER_NAME: "Your Name"
      CRON_TIME: "*/5 * * * *"
    volumes:
      - /host/path/to/ssh:/root/.ssh
      - /host/path/to/sync:/sync-dir
    restart: always