HTTP Substitutions Filter

Replace text in response bodies, using regular expressions and fixed strings, with the HTTP Substitutions Filter dynamic 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 HTTP Substitutions Filter module package nginx-plus-module-subs-filter.

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

    yum install nginx-plus-module-subs-filter
    

    For Amazon Linux 2023, AlmaLinux, Rocky Linux:

    dnf install nginx-plus-module-subs-filter
    

    For Debian and Ubuntu:

    apt-get install nginx-plus-module-subs-filter
    

    For SLES:

    zypper install nginx-plus-module-subs-filter
    

    For FreeBSD:

    pkg install nginx-plus-module-subs-filter
    

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