rookiezoe/nginx

Nginx 增强镜像（含 headers-more 和 nchan 模块）

镜像概述

基于官方 nginx:alpine 镜像构建，集成 headers-more-nginx-module 和 nchan 模块，在保持轻量级特性的同时，扩展Nginx的HTTP头处理和实时通信能力。

核心功能与特性

• headers-more-nginx-module：提供灵活的HTTP请求头/响应头修改能力，支持添加、删除、替换自定义头信息。
• nchan 模块：实现WebSocket、HTTP长轮询、发布/订阅等实时通信功能，支持高并发实时数据传输。
• 轻量级基础：基于 alpine 系统构建，镜像体积小，资源占用低，兼容官方Nginx所有标准功能。

适用场景

• 需要自定义HTTP头的Web服务（如API网关、安全加固、跨域配置）。
• 实时通信应用（如WebSocket服务、实时通知系统、在线聊天、实时数据监控）。
• 需扩展Nginx功能且追求轻量部署的场景（如边缘计算节点、微服务网关）。

使用方法与配置说明

基础使用

与官方Nginx镜像完全兼容，支持通过docker run直接启动或结合docker-compose编排部署。

模块加载配置

必须在nginx.conf配置文件开头添加模块加载指令，否则模块功能不可用：

nginx
# nginx.conf 开头添加
load_module modules/ngx_nchan_module.so;          # 加载 nchan 模块
load_module modules/ngx_http_headers_more_filter_module.so;  # 加载 headers-more 模块

# 后续配置与官方Nginx完全一致（如worker_processes、events、http块等）
events {
    worker_connections 1024;
}
http {
    include       /etc/nginx/mime.types;
    default_type  application/octet-stream;
    # ... 其他配置 ...
}

完整部署示例

1. 准备自定义 nginx.conf

创建包含模块加载的配置文件（示例路径：./conf/nginx.conf）：

nginx
load_module modules/ngx_nchan_module.so;
load_module modules/ngx_http_headers_more_filter_module.so;

worker_processes auto;

events {
    worker_connections 1024;
}

http {
    include       /etc/nginx/mime.types;
    default_type  application/octet-stream;

    # headers-more 模块示例：添加自定义响应头
    more_set_headers "X-Powered-By: Custom-Nginx";
    more_set_headers "Strict-Transport-Security: max-age=31536000; includeSubDomains";

    # nchan 模块示例：配置 WebSocket 服务
    server {
        listen 80;
        server_name localhost;

        location /ws {
            nchan_channel_id $arg_channel;  # 按请求参数区分频道
            nchan_pubsub;                   # 启用发布/订阅模式
            nchan_subscriber_concurrency broadcast;  # 支持广播模式
        }
    }
}

Docker 启动示例

1. 直接运行（本地配置文件挂载）

bash
docker run -d \
  -p 80:80 \
  -v $(pwd)/conf/nginx.conf:/etc/nginx/nginx.conf \  # 挂载自定义配置
  -v $(pwd)/html:/usr/share/nginx/html \            # 挂载网站内容（可选）
  --name nginx-enhanced \
  rookiezoe/nginx-enhanced:latest

2. docker-compose 配置示例

yaml
version: '3'
services:
  nginx:
    image: docker.xuanyuan.run/rookiezoe/nginx-enhanced:latest
    ports:
      - "80:80"
    volumes:
      - ./conf/nginx.conf:/etc/nginx/nginx.conf
      - ./html:/usr/share/nginx/html
    restart: always

注意事项

• 除模块加载配置外，其他所有配置（如虚拟主机、SSL、反向代理等）与官方 nginx:alpine 镜像完全一致。
• 模块文件路径固定为 modules/ngx_nchan_module.so 和 modules/ngx_http_headers_more_filter_module.so，不可修改。
• 如需自定义模块编译参数，需基于此镜像二次构建或参考官方文档调整编译配置。