NGINX Developer Kit

The NGINX Developer Kit (NDK) module makes it easier for module developers to develop NGINX modules.

The NDK module is also a prerequisite for Encrypted Session, Lua, and Set-Misc modules.

Installation

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

  2. Install the NDK module package nginx-plus-module-ndk.

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

    yum install nginx-plus-module-ndk
    

    For Amazon Linux 2023, AlmaLinux, Rocky Linux:

    dnf install nginx-plus-module-ndk
    

    For Debian and Ubuntu:

    apt-get install nginx-plus-module-ndk
    

    For SLES:

    zypper install nginx-plus-module-ndk
    

    For Alpine:

    apk add nginx-plus-module-ndk
    

    For FreeBSD:

    pkg install nginx-plus-module-ndk
    

Configuration

After installation you will need to enable and configure the module in NGINX Plus configuration file nginx.conf.

  1. Enable dynamic loading of the module with the load_module directive specified in the top-level (“main”) context:

    load_module modules/ndk_http_module.so;
    
  2. Perform additional configuration as required by the module.

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

    nginx -t && nginx -s reload
    

More Info