petekaik/nginx-healthcheck

nginx-healthcheck 镜像文档

镜像概述

nginx-healthcheck是一个基于Nginx的镜像，内置简单健康检查机制，通过访问http://localhost:80端点实现服务健康状态监控。该镜像支持通过环境变量灵活配置网络、端口映射、目录挂载等关键参数，适用于需要健康检查功能的Nginx服务部署场景。

核心功能与特性

• 内置健康检查：默认监听http://localhost:80作为健康检查端点，便于容器编排工具（如Docker Compose、Kubernetes）监控服务状态
• 参数可配置：支持通过环境变量或.env文件自定义网络、端口、目录等配置
• 灵活部署：适配Docker Compose等容器编排工具，支持自定义web根目录、配置文件目录及证书目录

使用场景

• 需要健康检查机制的Nginx服务部署
• 容器化环境中对Nginx服务状态进行实时监控的场景
• 需要自定义Nginx配置、web资源或SSL证书的应用场景

使用方法与配置说明

环境变量配置

可通过环境变量配置以下核心参数：

Docker Run 部署示例

bash
docker run -d \
  --name nginx-healthcheck \
  --network my-network \
  -p 8080:80 \
  -p 4433:443 \
  -v ./html:/usr/share/nginx/html \
  -v ./conf.d:/etc/nginx/conf.d \
  -v ./certs:/etc/nginx/certs \
  nginx-healthcheck

Docker Compose 部署示例

1. 创建 docker-compose.yml

yaml
version: '3'
services:
  nginx:
    image: nginx-healthcheck
    container_name: nginx-healthcheck
    network_mode: ${NETWORK}
    ports:
      - "${HTTP_PORT}:80"
      - "${HTTPS_PORT}:443"
    volumes:
      - "${WEB_ROOT}:/usr/share/nginx/html"
      - "${CONF_D}:/etc/nginx/conf.d"
      - "${CERT_FOLDER}:/etc/nginx/certs"

2. 创建 .env 配置文件

env
NETWORK=my-network
HTTP_PORT=8080
HTTPS_PORT=4433
WEB_ROOT=./html
CONF_D=./conf.d
CERT_FOLDER=./certs

3. 启动服务

bash
docker-compose up -d

健康检查验证

服务启动后，可通过以下命令验证健康检查状态：

bash
docker inspect --format='{{.State.Health.Status}}' nginx-healthcheck

返回 healthy 表示服务健康。