Skip to content

Perl

Implement location and variable handlers in Perl and insert Perl calls into Server Side Includes (SSI), with the Perl dynamic module, supported by NGINX, Inc.

The Perl dynamic module allows implementing location and variable handlers in Perl and insert Perl calls into Server Side Includes (SSI).

  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 Perl module package nginx-plus-module-perl from the official NGINX Plus repository.

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

    Terminal window
    sudo yum update && \
    sudo yum install nginx-plus-module-perl

    For Amazon Linux 2023, AlmaLinux, Rocky Linux:

    Terminal window
    sudo dnf update && \
    sudo dnf install nginx-plus-module-perl

    For Debian/Ubuntu:

    Terminal window
    sudo apt update && \
    sudo apt install nginx-plus-module-perl

    For SLES:

    Terminal window
    sudo zypper refresh && \
    sudo zypper install nginx-plus-module-perl

    For Alpine:

    Terminal window
    apk add nginx-plus-module-perl

    For FreeBSD:

    Terminal window
    sudo pkg update && \
    sudo pkg install nginx-plus-module-perl

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_perl_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:

    Terminal window
    nginx -t

    Expected output of the command:

    Terminal window
    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:

    Terminal window
    nginx -s reload