nginx-unit-lua

中文文档 / English doc

介绍

Nginx-Unit 的 Lua5.4/LuaJIT 支持。 可运行 Lor/Vanilla 框架，有针对性的做了 Openresty 适配。

只初步实现了 HTTP 功能。 只在 MacOS 上测试过。

软件架构

Lua 并非像 Unit 官方支持的那些语言一样集成到 Unit 中， 而是外部应用的形式（配置类型为 external ）。

Unit 启动时（或者应用配置变更时），根据配置启动 Lua 应用进程， 通过已经编译为 Lua 共享库的 Unit 通信模块交互。 Unit 主进程会启动三个功能性进程控制器、路由器、应用原型， 以及若干应用进程，各类进程间互有通信。

• build/ 构建所需的源码和依赖。
• lib/ 运行时依赖的库文件。
• config/ 运行时和 App 配置文件。
• frameworks/ App 依赖的框架。
• apps/ App 。
• unitd.lua UNIT 服务管理、查看状态和配置、 App 启动入口。

安装教程

1. 依赖：

   • lua-cjson
   • base64
   • luaffifb

2. 编译 build/deps/base64 ：

   1. • 解压 build/deps/ 中的 base64 源码包，
      • MacOS: 修改 ./Makefile ，注释掉目标 lib/libbase64.o 下的 $(OBJCOPY) 指令，
      • （ MacOS 中会导致编译失败、运行失败，找不到符号。）

   2.  # 生成文件 lib/libbase64.o, lib/config.h
       # x86
       SSSE3_CFLAGS=-mssse3 \
       SSE41_CFLAGS=-msse4.1 \
       SSE42_CFLAGS=-msse4.2 \
       AVX2_CFLAGS=-mavx2 \
       AVX_CFLAGS=-mavx \
           make lib/libbase64.o
      

   3. (cd test; make test) # 执行 test 和 benchmark

3. 构建 nginx-unit-lua ：

   cd ..
   # 针对 Lua5.4 生成 ./Makefile 及各共享库的 Makefile
   # 编译配置： ./make/inc.lua 以及各个共享库目录中的 make.lua
   # luajit make.lua
   ./make.lua # -g 生成调试信息， -r 无调试信息
   make
   make clean
   

使用说明

• 在 UNIT-ROOT/ 中：

  • config/config.lua 可配置 UNIT 、注册框架和 App 。
  • 执行 ./unitd.lua 进行管理，可指定如下命令：
    • [i[nfo]] 缺省命令，查看可用命令、注册的 App 列表
    • r[estart], s[tart], q[uit] 管理 unitd
    • v[host] [APP-NAME/No.] 查看当前 UNIT 的 vhost 配置， JSON 格式
    • d[etail] [APP-NAME/No.] 无参列举注册的 App 信息， 参数指定 App 则显示其注册信息、配置信息、 ngx 配置和 vhost 配置。
    • u[pdate] [APP-NAME/No.] 处理配置并更新 UNIT 的 vhost 配置。
    • g[et] <APP-NAME/No.> GET 请求测试

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request