muen/openresty

OpenResty 集成版镜像文档

镜像概述

本镜像基于Ubuntu Focal构建，包含OpenResty 1.25.3.2及多个扩展模块，旨在提供高性能、可监控且具备安全防护能力的Web服务解决方案。镜像集成了虚拟主机状态监控、Prometheus指标导出和Web应用防火墙功能，适用于生产环境中的反向代理、API网关和Web服务部署。

核心功能与特性

基础组件

• OpenResty版本：1.25.3.2（基于Nginx核心）
• OpenSSL版本：1.1.1w（含OpenResty补丁）
• PCRE版本：8.45（支持JIT编译）
• LuaJIT：集成LuaJIT 2.1，支持Lua 5.2兼容模式
• LuaRocks：3.11.0（Lua包管理工具）

扩展模块

• nginx-module-vts：0.2.3版本，提供虚拟主机流量监控功能
• ngx_waf：10.1.2版本，Web应用防火墙，支持SQL注入、XSS等***防护
• nginx-lua-prometheus：0.20230607版本，Prometheus指标导出模块
• pgmoon：PostgreSQL Lua客户端库

核心特性

• 支持HTTP/2、HTTP/3协议
• 内置多种Nginx核心模块（SSL、gzip、realip、stub_status等）
• 日志重定向至stdout/stderr，支持容器日志收集
• 优化的Lua环境配置，预设LUA_PATH和LUA_CPATH
• 支持优雅关闭（使用SIGQUIT信号）

使用场景

• 高性能反向代理服务器
• API网关（支持Lua脚本扩展）
• 需要流量监控的Web服务
• 需要基础WAF防护的应用
• Prometheus可监控的Web服务架构

构建参数

环境变量

使用方法

基本运行

bash
docker run -d -p 80:80 -p 443:443 --name openresty-integrated your-image-name

挂载配置文件

bash
docker run -d -p 80:80 -p 443:443 \
  -v /path/to/nginx.conf:/usr/local/openresty/nginx/conf/nginx.conf \
  -v /path/to/conf.d:/etc/nginx/conf.d \
  --name openresty-integrated your-image-name

Docker Compose示例

yaml
version: '3'
services:
  openresty:
    image: your-image-name
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - ./nginx.conf:/usr/local/openresty/nginx/conf/nginx.conf
      - ./conf.d:/etc/nginx/conf.d
      - ./ssl:/etc/nginx/ssl
    restart: always
    stop_signal: SIGQUIT

配置说明

主要配置文件

• 主配置文件：/usr/local/openresty/nginx/conf/nginx.conf
• 虚拟主机配置：/etc/nginx/conf.d/default.conf（可通过挂载覆盖）

模块配置示例

Prometheus指标导出

在Nginx配置中添加：

nginx
lua_shared_dict prometheus_metrics 10M;
init_by_lua_block {
  prometheus = require("prometheus").init("prometheus_metrics")
  metric_requests = prometheus:counter("nginx_http_requests_total", "Number of HTTP requests", {"host", "status"})
  metric_latency = prometheus:histogram("nginx_http_request_duration_seconds", "HTTP request latency", {"host"})
}

log_by_lua_block {
  metric_requests:inc(1, {ngx.var.host, ngx.var.status})
  metric_latency:observe(ngx.now() - ngx.req.start_time(), {ngx.var.host})
}

location /metrics {
  content_by_lua_block {
    prometheus:collect()
  }
}

nginx-module-vts配置

nginx
http {
  vhost_traffic_status_zone;
  
  server {
    vhost_traffic_status off;  # 默认为on，可关闭特定虚拟主机监控
    location /status {
      vhost_traffic_status_display;
      vhost_traffic_status_display_format json;
    }
  }
}

ngx_waf配置

nginx
http {
  waf on;
  waf_mode SYNTHETIC;
  waf_rule_path /usr/local/openresty/nginx/conf/waf/rules/;
  waf_log /var/log/nginx/waf.log;
  waf_cc_deny rate=100/r duration=60m;
}

维护信息

• 维护者：Evan Wies <***>
• 基础镜像：Ubuntu Focal
• 停止信号：SIGQUIT（用于优雅关闭，确保请求完成）