openweb/git-sync

openweb/git-sync 镜像文档

镜像概述和主要用途

openweb/git-sync 是一个从 https://github.com/joemccann/dillinger 分叉的Docker容器，核心功能是将指定卷的内容与Git仓库同步。它通过环境变量配置同步参数，支持定期拉取仓库更新，适用于需要动态获取Git仓库内容的场景，如静态网站资源同步、配置文件更新等。

核心功能和特性

• 卷与Git仓库同步：自动将Git仓库内容同步到指定卷，确保卷内数据与仓库保持一致
• 灵活的环境变量配置：通过环境变量设置同步参数，无需修改镜像本身
• 定期同步机制：可配置同步间隔时间（GIT_SYNC_WAIT），实现周期性内容更新
• 分支与版本控制：支持指定同步的Git分支（GIT_SYNC_BRANCH）和版本（GIT_SYNC_REV）

使用场景和适用范围

• 静态网站内容更新：配合Nginx等Web服务器，从Git仓库动态同步静态HTML、CSS、JS等资源
• 配置文件同步：将应用配置文件存储在Git仓库，通过该镜像定期同步到容器卷
• 代码或资源定期拉取：任何需要从Git仓库定期获取内容并挂载到其他容器的场景

使用方法和配置说明

不使用docker compose

步骤1：创建本地卷

bash
docker volume create -d local --name website_sources

步骤2：运行git-sync容器

bash
docker run --name git-sync -d  \
    -e GIT_SYNC_REPO=https://github.com/openweb-nl/website-static.git \
    -e GIT_SYNC_DEST=/git \
    -e GIT_SYNC_BRANCH=master \
    -e GIT_SYNC_REV=FETCH_HEAD \
    -e GIT_SYNC_WAIT=10 \
    -v website_sources:/git docker.xuanyuan.run/openweb/git-sync:0.0.1

步骤3：运行应用容器（以Nginx为例）

bash
docker run --name docker.xuanyuan.run/nginx \
    -d -p 8080:80 -v website_sources:/usr/share/nginx/html docker.xuanyuan.run/nginx

使用docker compose

步骤1：创建docker-compose.yml文件

yml
version: '2'

services:
  nginx:
    image: docker.xuanyuan.run/nginx:latest
    ports:
      - "8080:80"
    volumes:
      - website_sources:/usr/share/nginx/html:z
    depends_on:
      - git-sync
    restart: always
  git-sync:
    image: docker.xuanyuan.run/openweb/git-sync:0.0.1
    environment:
      GIT_SYNC_REPO: "https://github.com/openweb-nl/website-static.git"
      GIT_SYNC_DEST: "/git"
      GIT_SYNC_BRANCH: "master"
      GIT_SYNC_REV: "FETCH_HEAD"
      GIT_SYNC_WAIT: "10"
    volumes:
      - website_sources:/git:z
    restart: always
volumes:
  website_sources:
    driver: local

步骤2：启动容器

bash
docker-compose up -d

环境变量说明