Lua

Integrate Lua co-routines into the NGINX event-processing model with the community-authored Lua dynamic module.

Prerequisites

  1. Check the Technical Specifications page to verify that the module is supported by your operating system.

  2. Prior to installing the module, verify that the NGINX Developer Kit (NDK) module is already installed.

Installation

Install the Lua module package nginx-plus-module-lua.

For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:

yum install nginx-plus-module-lua

For Amazon Linux 2023, AlmaLinux, Rocky Linux:

dnf install nginx-plus-module-lua

For Debian and Ubuntu:

apt-get install nginx-plus-module-lua

For SLES:

zypper install nginx-plus-module-lua

For Alpine:

apk add nginx-plus-module-lua

For FreeBSD:

pkg install nginx-plus-module-lua

Configuration

After installation, enable and configure the modules in NGINX Plus configuration file nginx.conf.

  1. Enable dynamic loading of NDK and Lua modules with the load_module directives specified in the top-level (“main”) context:

    load_module modules/ndk_http_module.so;
load_module modules/ngx_http_lua_module.so;
load_module modules/ngx_stream_lua_module.so;
    Note:
    The ndk_http_module.so module must be placed first.

  2. Configure additional settings as needed for the modules. For details, see the lua-nginx-module and stream-lua-nginx-module documentation.

  3. Test the configuration and reload NGINX Plus to enable the module:

    nginx -t && nginx -s reload

More Info

Last modified January 8, 2025