ngx_zeromq 技术文档

1. 安装指南

由于 ngx_zeromq 是一个 nginx 的扩展模块，因此安装之前请确保您已经安装了 nginx。以下是安装 ngx_zeromq 的基本步骤：

1. 下载 ngx_zeromq 模块的源代码。
2. 解压下载的文件到 nginx 源代码目录下。
3. 编译并安装 nginx，确保在编译时包含了 ngx_zeromq 模块。

# 以下命令仅供参考，具体命令可能根据实际情况有所不同
wget http://example.com/ngx_zeromq.tar.gz
tar zxvf ngx_zeromq.tar.gz
cd /path/to/nginx-source
./configure --with-ngx_zeromq
make
make install

2. 项目的使用说明

ngx_zeromq 模块允许 nginx 使用 ZeroMQ 作为消息导向的传输层与上游服务器通信。该模块在第七层协议上是无关的，这意味着它可以与任何行为良好的上游模块（如 proxy、fastcgi、uwsgi、scgi 等）一起使用。

注意事项：

• 目前，ngx_zeromq 仅支持 ZeroMQ 的 REQ/REP 模式，这意味着上游响应必须在一个单独的 ZeroMQ 消息中发送（尽管可以是多部分消息）。
• 每个消息部分必须适应上游缓冲区的大小。
• ZeroMQ 对于文件描述符的需求很高，一旦耗尽，将导致工作进程崩溃。为了防止这种情况发生，工作连接数限制应该设置为文件描述符限制的几倍以下。

3. 项目API使用文档

ngx_zeromq 模块提供了以下配置指令：

• zeromq_threads：设置每个工作进程使用的 ZeroMQ I/O 线程数。
• zeromq_local：配置本地 ZeroMQ 端点。
• zeromq_remote：配置远程 ZeroMQ 端点。
• zeromq_single：启用单端口模式，仅适用于测试和开发，不应在生产环境中使用。

配置指令示例：

http {
    upstream blackhole {
        zeromq_remote   REQ tcp://127.0.0.1:5555;
    }

    server {
        location / {
            proxy_pass  http://blackhole;
        }
    }
}

4. 项目安装方式

ngx_zeromq 模块的安装方式已在“安装指南”部分进行了说明。请参考上述步骤进行安装。在编译 nginx 时，确保包含了 ngx_zeromq 模块。

请注意，本技术文档的内容基于项目 readme 文件和 github 项目 wiki，具体使用过程中可能需要根据实际环境进行调整。