bdhwan/nginx-git-html

nginx-git-html 镜像文档

镜像概述

nginx-git-html是一个整合Nginx Web服务器与Git版本控制功能的Docker镜像，旨在提供静态网站的自动化部署方案。该镜像能够自动从配置的Git仓库拉取HTML等静态资源文件，并通过内置的Nginx服务对外提供Web访问，适用于需要快速部署或动态更新静态内容的场景。

核心功能与特性

• Git资源拉取：支持从指定Git仓库自动拉取静态资源，可处理包含用户名密码认证的仓库地址
• 分支灵活选择：允许指定拉取Git仓库的特定分支，满足多环境部署需求
• 目标路径定制：可设置Git仓库中的具体文件夹作为Nginx服务的根目录
• Nginx集成：内置Nginx服务，资源拉取完成后自动启动，默认监听80端口
• 配置简洁：通过环境变量即可完成核心参数配置，无需复杂的手动配置文件

使用场景与适用范围

• 静态网站快速部署（如个人博客、企业官网、营销页面等）
• 多环境静态资源管理（开发、测试、生产环境分别拉取不同分支资源）
• 需频繁更新静态内容的场景（避免手动上传文件到服务器）
• 容器化环境中的静态资源自动化部署

使用方法与配置说明

环境变量配置

Docker Run 部署示例

bash
docker run -d \
  --name static-web \
  -e GIT_URL="https://user:pass@github.com/example/static-site.git" \
  -e DST_FOLDER="dist" \
  -e BRANCH="main" \
  -p 8080:80 \
  docker.xuanyuan.run/bdhwan/nginx-git-html:3.7

Docker Compose 配置示例

yaml
version: "3.3"
services:
  beta-user:
    hostname: 'beta-user'
    image: docker.xuanyuan.run/bdhwan/nginx-git-html:3.7
    environment:
      - GIT_URL=some_git_url_with_id_pw_if_need  # Git仓库地址（含认证信息）
      - DST_FOLDER=root_folder_from_git_url      # Git仓库中的静态文件根目录
      - BRANCH=master                            # 拉取的分支名称
    ports:
      - "8010:80"  # 宿主机端口映射到容器内Nginx默认端口（80）
    deploy:
      placement:
        constraints:
          - node.labels.html_user == html_user  # 可选：Docker Swarm节点部署约束

部署说明

1. 确保Docker环境已正确安装并运行
2. 配置GIT_URL时，若仓库需要认证，需按格式包含用户名和密码
3. 通过-p参数映射宿主机端口到容器的80端口，访问时使用宿主机端口
4. DST_FOLDER若不指定，默认使用Git仓库的根目录作为Nginx服务根目录
5. 如需在Docker Swarm集群中部署，可通过deploy配置节点标签约束，指定服务运行节点