njs Scripting Language

Integrate JavaScript-like code into the NGINX event-processing model for HTTP or TDP/UDP, with the NGINX njs module, supported by NGINX, Inc.

Installation

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

  2. Install the njs module package nginx-plus-module-njs.

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

    yum install nginx-plus-module-njs

    For Amazon Linux 2023, AlmaLinux, Rocky Linux:

    dnf install nginx-plus-module-njs

    For Debian and Ubuntu:

    apt-get install nginx-plus-module-njs

    For SLES:

    zypper install nginx-plus-module-njs

    For Alpine:

    apk add nginx-plus-module-njs

    For FreeBSD:

    pkg install nginx-plus-module-njs

Configuration

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

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

    load_module modules/ngx_http_js_module.so;
load_module modules/ngx_stream_js_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