NGINX Documentation

Lua

Integrate Lua co‑routines into the NGINX event‑processing model.

Installation Instructions

  1. Prior to installing the Lua module, verify that the NDK module is already installed.

  2. Install the Lua module.

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

    $ yum 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
    
  3. Put the load_module directives for NDK and Lua modules in the top‑level (“main”) context of NGINX Plus configuration file, nginx.conf:

    load_module modules/ndk_http_module.so;
    load_module modules/ngx_http_lua_module.so;
    

    Note: The directives must be in this order.

  4. Perform additional configuration as required by the module.

  5. Reload NGINX Plus to enable the module:

    $ nginx -t && nginx -s reload
    

More Info