Skip to content

fix: Add support for NAP v4.16.0/v5.8.0 in NIM #1002

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 25, 2025
Merged

fix: Add support for NAP v4.16.0/v5.8.0 in NIM #1002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c323291
fix: Update setup-waf-config-management.md
vvnginx Aug 20, 2025
67ad814
fix: Update nim-app-protect-support.md
vvnginx Aug 20, 2025
ce1cf1a
Merge branch 'main' into patch-5
mjang Aug 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/includes/nim/tech-specs/nim-app-protect-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ NGINX Instance Manager supports the following versions of [NGINX App Protect WAF

| NGINX Instance Manager | NGINX App Protect WAF |
|------------------------|------------------------------------|
| 2.17.0–2.20.0 | Release 4.8.0–4.15.0, 5.1.0–5.7.0 |
| 2.17.0–2.20.0 | Release 4.8.0–4.16.0, 5.1.0–5.8.0 |
| 2.15.1–2.16.0 | Release 4.8.0–4.10.0 |
| 2.14.1–2.15.0 | Release 4.4.0–4.7.0 |
| 2.13.0–2.14.0 | Release 4.3.0–4.5.0 |
Expand Down
42 changes: 22 additions & 20 deletions content/nim/nginx-app-protect/setup-waf-config-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,15 @@ The table below shows which WAF compiler version to use for each version of NGIN

| NGINX App Protect WAF version | WAF compiler version |
|-------------------------------|----------------------------|
| 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 |
Expand All @@ -88,13 +90,13 @@ The table below shows which WAF compiler version to use for each version of NGIN
To install the WAF compiler on Debian or Ubuntu, run the following command:

```shell
sudo apt-get install nms-nap-compiler-v5.442.0
sudo apt-get install nms-nap-compiler-v5.498.0
```

If you want to install more than one version of the WAF compiler on the same system, append the `--force-overwrite` option to the install command after the first installation:

```shell
sudo apt-get install nms-nap-compiler-v5.442.0 -o Dpkg::Options::="--force-overwrite"
sudo apt-get install nms-nap-compiler-v5.498.0 -o Dpkg::Options::="--force-overwrite"
```

{{< include "nim/nap-waf/restart-nms-integrations.md" >}}
Expand All @@ -118,7 +120,7 @@ To install the WAF compiler on RHEL 8.1 :
3. Install the WAF compiler:

```shell
sudo yum install nms-nap-compiler-v5.442.0
sudo yum install nms-nap-compiler-v5.498.0
```

### RHEL 9
Expand All @@ -140,7 +142,7 @@ To install the WAF compiler on RHEL 9:
3. Install the WAF compiler:

```shell
sudo yum install nms-nap-compiler-v5.442.0
sudo yum install nms-nap-compiler-v5.498.0
```

4. {{< include "nim/nap-waf/restart-nms-integrations.md" >}}
Expand All @@ -164,7 +166,7 @@ To install the WAF compiler on Oracle Linux 8.1:
3. Install the WAF compiler:

```shell
sudo yum install nms-nap-compiler-v5.442.0
sudo yum install nms-nap-compiler-v5.498.0
```

4. {{< include "nim/nap-waf/restart-nms-integrations.md" >}}
Expand Down Expand Up @@ -250,7 +252,7 @@ To install the WAF compiler on a system without internet access, complete these


Note : Version of NAP compiler can be referred from the table at the top of this page.
Current latest version 5.442.0 at the point of writing this document is used in below commands.
Current latest version 5.498.0 at the point of writing this document is used in below commands.

{{<tabs name="WAF compiler installation in offline environment">}}

Expand Down Expand Up @@ -280,10 +282,10 @@ sudo wget -q -O /etc/apt/apt.conf.d/90pkgs-nginx https://cs.nginx.com/static/fil
mkdir -p compiler && cd compiler
sudo apt-get update

sudo apt-get download nms-nap-compiler-v5.442.0
sudo apt-get download nms-nap-compiler-v5.498.0
cd ../
mkdir -p compiler/compiler.deps
sudo apt-get install --download-only --reinstall --yes --print-uris nms-nap-compiler-v5.442.0 | grep ^\' | cut -d\' -f2 | xargs -n 1 wget -P ./compiler/compiler.deps
sudo apt-get install --download-only --reinstall --yes --print-uris nms-nap-compiler-v5.498.0 | grep ^\' | cut -d\' -f2 | xargs -n 1 wget -P ./compiler/compiler.deps

tar -czvf compiler.tar.gz compiler/
```
Expand Down Expand Up @@ -326,10 +328,11 @@ sudo wget -q -O /etc/apt/apt.conf.d/90pkgs-nginx https://cs.nginx.com/static/fil
mkdir -p compiler && cd compiler
sudo apt-get update

sudo apt-get download nms-nap-compiler-v5.442.0
sudo apt-get download nms-nap-compiler-v5.498.0

cd ../
mkdir -p compiler/compiler.deps
sudo apt-get install --download-only --reinstall --yes --print-uris nms-nap-compiler-v5.442.0 | grep ^\' | cut -d\' -f2 | xargs -n 1 wget -P ./compiler/compiler.deps
sudo apt-get install --download-only --reinstall --yes --print-uris nms-nap-compiler-v5.498.0 | grep ^\' | cut -d\' -f2 | xargs -n 1 wget -P ./compiler/compiler.deps
tar -czvf compiler.tar.gz compiler/
```

Expand Down Expand Up @@ -367,7 +370,7 @@ sudo yum-config-manager --disable rhel-9-appstream-rhui-rpms
sudo yum update -y
sudo mkdir -p nms-nap-compiler

sudo yumdownloader --resolve --destdir=nms-nap-compiler nms-nap-compiler-v5.442.0
sudo yumdownloader --resolve --destdir=nms-nap-compiler nms-nap-compiler-v5.498.0
tar -czvf compiler.tar.gz nms-nap-compiler/
```

Expand Down Expand Up @@ -411,8 +414,7 @@ EOF
sudo yum update -y
sudo mkdir -p nms-nap-compiler

sudo yumdownloader --resolve --destdir=nms-nap-compiler nms-nap-compiler-v5.442.0

sudo yumdownloader --resolve --destdir=nms-nap-compiler nms-nap-compiler-v5.498.0
tar -czvf compiler.tar.gz nms-nap-compiler/
```

Expand Down Expand Up @@ -1205,21 +1207,21 @@ sudo /opt/nms-nap-compiler/app_protect-<version>/bin/apcompile -h
**Example:**

```shell
sudo /opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -h
sudo /opt/nms-nap-compiler/app_protect-5.498.0/bin/apcompile -h
```

**Expected output:**

```text
USAGE:
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile <options>
/opt/nms-nap-compiler/app_protect-5.498.0/bin/apcompile <options>

Examples:
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -p /path/to/policy.json -o mypolicy.tgz
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -p policyA.json -g myglobal.json -o /path/to/policyA_bundle.tgz
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -g myglobalsettings.json --global-state-outfile /path/to/myglobalstate.tgz
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -b /path/to/policy_bundle.tgz --dump
/opt/nms-nap-compiler/app_protect-5.442.0/bin/apcompile -l logprofA.json -o /path/to/logprofA_bundle.tgz
/opt/nms-nap-compiler/app_protect-5.498.0/bin/apcompile -p /path/to/policy.json -o mypolicy.tgz
/opt/nms-nap-compiler/app_protect-5.498.0/bin/apcompile -p policyA.json -g myglobal.json -o /path/to/policyA_bundle.tgz
/opt/nms-nap-compiler/app_protect-5.498.0/bin/apcompile -g myglobalsettings.json --global-state-outfile /path/to/myglobalstate.tgz
/opt/nms-nap-compiler/app_protect-5.498.0/bin/apcompile -b /path/to/policy_bundle.tgz --dump
/opt/nms-nap-compiler/app_protect-5.498.0/bin/apcompile -l logprofA.json -o /path/to/logprofA_bundle.tgz
```

### Confirm NGINX Agent configuration on the NGINX App Protect WAF instance
Expand Down
Loading