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:

    sudo yum update && \
sudo yum install nginx-plus-module-ndk

    For Amazon Linux 2023, AlmaLinux, Rocky Linux:

    sudo dnf update && \
sudo dnf install nginx-plus-module-ndk

    For Debian and Ubuntu:

    sudo apt update && \
sudo apt install nginx-plus-module-ndk

    For SLES:

    sudo zypper refresh && \
sudo zypper install nginx-plus-module-ndk

    For Alpine:

    apk add nginx-plus-module-ndk

    For FreeBSD:

    sudo pkg update && \
sudo pkg install nginx-plus-module-ndk

Configuration

After installation you will need to enable and configure the module in F5 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;

http {
    # ...
}

  2. Perform additional configuration as required by the module.

  3. Test the NGINX Plus configuration. In a terminal, type-in the command:

    nginx -t

    Expected output of the command:

    nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf is successful

  4. Reload the NGINX Plus configuration to enable the module:

    nginx -s reload

More Info