Set-Misc

The Set-Misc dynamic module extends the NGINX core Rewrite by implementing numerous additional set_* directives.

Prerequisites

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

  2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the Installing NGINX Plus page.

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

Installation

Install the Set-Misc module package nginx-plus-module-set-misc from the official NGINX Plus repository.

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

sudo yum update && \
sudo yum install nginx-plus-module-set-misc

For Amazon Linux 2023, AlmaLinux, Rocky Linux:

sudo dnf update && \
sudo dnf install nginx-plus-module-set-misc

For Debian and Ubuntu:

sudo apt update && \
sudo apt install nginx-plus-module-set-misc

For SLES:

sudo zypper refresh && \
sudo zypper install nginx-plus-module-set-misc

For Alpine:

apk add nginx-plus-module-set-misc

For FreeBSD:

sudo pkg update && \
sudo pkg install nginx-plus-module-set-misc

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 NDK and Set-Misc 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_set_misc_module.so;

http {
    # ...
}
    Note: The directives must be in this order.

  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