Image-Filter

The Image-Filter dynamic module enables you to crop, resize, rotate, and apply various transformations to GIF, JPEG, and PNG images.

Installation

  1. Check theTechnical 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 theInstalling NGINX Plus page.

  3. Install the Image-Filter module packagenginx-plus-module-image-filter from the official NGINX Plus repository.

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

    shell
    sudo yum update&&\sudo yum install nginx-plus-module-image-filter
    sudo yum update&&\sudo yum install nginx-plus-module-image-filter

    For Amazon Linux 2023, AlmaLinux, Rocky Linux:

    shell
    sudo dnf update&&\sudo dnf install nginx-plus-module-image-filter
    sudo dnf update&&\sudo dnf install nginx-plus-module-image-filter

    For Debian and Ubuntu:

    shell
    sudo apt update&&\sudo apt install nginx-plus-module-image-filter
    sudo apt update&&\sudo apt install nginx-plus-module-image-filter

    For SLES:

    shell
    sudo zypper refresh&&\sudo zypper install nginx-plus-module-image-filter
    sudo zypper refresh&&\sudo zypper install nginx-plus-module-image-filter

    For Alpine:

    apk add nginx-plus-module-image-filter
    apk add nginx-plus-module-image-filter

    For FreeBSD:

    shell
    sudo pkg update&&\sudo pkg install nginx-plus-module-image-filter
    sudo pkg update&&\sudo pkg install nginx-plus-module-image-filter

Configuration

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

  1. Enable dynamic loading of the module with theload_module directive specified in the top-level (“main”) context:

    nginx
    load_modulemodules/ngx_http_image_filter_module.so;http{# ...}
    load_modulemodules/ngx_http_image_filter_module.so;http{# ...}

  2. Perform additional configuration as required by themodule.

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

    nginx -t
    nginx -t

    Expected output of the command:

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

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

    nginx -s reload
    nginx -s reload

More info