Install the WAF compiler

The WAF compiler lets NGINX Instance Manager precompile security configurations before deploying them to F5 WAF for NGINX instances.
Precompiling configurations improves performance and reduces the risk of runtime errors.

Install the WAF compiler on the NGINX Instance Manager host only if you plan to compile configurations on the management plane.
If you compile on the data plane, you can skip this step.

Each version of F5 WAF for NGINX has a corresponding WAF compiler version.
If you manage multiple versions, install the matching compiler for each one on the NGINX Instance Manager host.

The WAF compiler installs to the /opt directory.
Make sure this directory has the correct permissions so the owner can write to it. A typical permission setting of 0755 is sufficient.

To organize instances running the same version, you can create instance groups.

For an overview of how the compiler works, see Security bundle compilation.

Before you begin

Make sure you’ve completed the following tasks:

  • You have one or more F5 WAF for NGINX instances running.
    For supported versions, see Support for F5 WAF for NGINX.

    If you plan to use configuration management and Security Monitoring, follow the steps in the setup guide before continuing.

  • NGINX Instance Manager is installed, licensed, and running.

    The latest version of NGINX Instance Manager is recommended to ensure full compatibility and access to the newest features.

    If you have a subscription for F5 WAF for NGINX, you can find your license in the subscription details section of MyF5.

WAF compiler version support

Use the table below to find the correct WAF compiler version for each release of F5 WAF for NGINX:

F5 WAF for NGINX version WAF compiler version
5.9.0 nms-nap-compiler-v5.527.0
5.8.0 nms-nap-compiler-v5.498.0
5.7.0 nms-nap-compiler-v5.442.0
5.6.0 nms-nap-compiler-v5.342.0
5.5.0 nms-nap-compiler-v5.264.0
5.4.0 nms-nap-compiler-v5.210.0
5.3.0 nms-nap-compiler-v5.144.0
5.2.0 nms-nap-compiler-v5.48.0
5.1.0 nms-nap-compiler-v5.17.0
4.16.0 nms-nap-compiler-v5.498.0
4.15.0 nms-nap-compiler-v5.442.0
4.14.0 nms-nap-compiler-v5.342.0
4.13.0 nms-nap-compiler-v5.264.0
4.12.0 nms-nap-compiler-v5.210.0
4.11.0 nms-nap-compiler-v5.144.0
4.10.0 nms-nap-compiler-v5.48.0
4.9.0 nms-nap-compiler-v5.17.0
4.8.1 nms-nap-compiler-v4.815.0
Beginning with version 5.9.0, both the virtual machine and container installation packages are categorized under the 5.x.x tag.
Earlier releases used 4.x.x for VM packages (for example, NAP 4.15.0, NAP 4.16.0) and 5.x.x for container packages (for example, NAP 5.7.0, NAP 5.8.0).

Install the WAF compiler

  1. Install the WAF compiler:

    sudo apt-get install nms-nap-compiler-v5.527.0

  2. To install multiple compiler versions on the same system, append the --force-overwrite option after the first installation:

    sudo apt-get install nms-nap-compiler-v5.527.0 -o Dpkg::Options::="--force-overwrite"

  3. Restart the nms-integrations service:

sudo systemctl restart nms-integrations

  1. Download the dependencies.repo file to /etc/yum.repos.d:

    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.repo

  2. Enable the CodeReady Builder repository:

    sudo subscription-manager repos --enable codeready-builder-for-rhel-8-x86_64-rpms

  3. Install the WAF compiler:

    sudo yum install nms-nap-compiler-v5.527.0

  4. Restart the nms-integrations service:

sudo systemctl restart nms-integrations

  1. Download the dependencies.repo file to /etc/yum.repos.d:

    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.repo

  2. Enable the CodeReady Builder repository:

    sudo subscription-manager repos --enable codeready-builder-for-rhel-9-x86_64-rpms

  3. Install the WAF compiler:

    sudo yum install nms-nap-compiler-v5.527.0

  4. Restart the nms-integrations service:

sudo systemctl restart nms-integrations

  1. Download the dependencies.repo file to /etc/yum.repos.d:

    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.repo

  2. Enable the ol8_codeready_builder repository:

    sudo yum-config-manager --enable ol8_codeready_builder

  3. Install the WAF compiler:

    sudo yum install nms-nap-compiler-v5.527.0

  4. Restart the nms-integrations service:

sudo systemctl restart nms-integrations
View source
Edit this page
Create a new issue