HTTP Substitutions Filter

The HTTP Substitutions Filter dynamic module replaces text in response bodies, using regular expressions and fixed strings.

Installation

  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. Install the HTTP Substitutions Filter module package nginx-plus-module-subs-filter from the official NGINX Plus repository.

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

    sudo yum update && \
sudo yum install nginx-plus-module-subs-filter

    For Amazon Linux 2023, AlmaLinux, Rocky Linux:

    sudo dnf update && \
sudo dnf install nginx-plus-module-subs-filter

    For Debian and Ubuntu:

    sudo apt update && \
sudo apt install nginx-plus-module-subs-filter

    For SLES:

    sudo zypper refresh && \
sudo zypper install nginx-plus-module-subs-filter

    For FreeBSD:

    sudo pkg update && \
sudo pkg install nginx-plus-module-subs-filter

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/ngx_http_subs_filter_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