Skip to content

docs: update the NAP and NIM versions for new NIM NAP compiler #767

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 4 commits into from
Jul 1, 2025
Merged

docs: update the NAP and NIM versions for new NIM NAP compiler #767

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
803cd78
docs: update the NAP and NIM versions for new NIM NAP compiler
balakoteswar Jul 1, 2025
e8e73d4
fix: Update content/includes/nim/tech-specs/security-data-plane-depen…
balakoteswar Jul 1, 2025
0e0ffed
fix: Update content/includes/nim/tech-specs/security-management-plane…
balakoteswar Jul 1, 2025
2100274
Merge branch 'main' into app-protect-415
ADubhlaoich Jul 1, 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.19.2 | Release 4.8.0–4.14.0, 5.1.0–5.6.0 |
| 2.17.0–2.20.0 | Release 4.8.0–4.15.0, 5.1.0–5.7.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
3 changes: 3 additions & 0 deletions content/includes/nim/tech-specs/security-data-plane-dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
The Security Monitoring module requires the following versions of [NGINX App Protect WAF](https://docs.nginx.com/nginx-app-protect/) and [NGINX Plus](https://www.f5.com/products/nginx/nginx-plus) for the **data plane**:

{{< note >}}Nginx Instance Manager v2.19.0 or higher: The Security Monitoring module is one of the in-built feature of Nginx Instance Manager. You'll need not to manually install or upgrade NGINX Instance Manager to a supported version.
{{< /note >}}

{{<bootstrap-table "table table-striped table-bordered">}}

| Security Monitoring | NGINX App Protect WAF |
Expand Down
5 changes: 4 additions & 1 deletion content/includes/nim/tech-specs/security-management-plane-dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
The Security Monitoring module requires the following versions of NGINX Instance Manager to be installed on the **management plane**.

{{< note >}}The Security Monitoring module doesn’t automatically install or upgrade NGINX Instance Manager. You’ll need to manually install or upgrade NGINX Instance Manager to a supported version.
{{< note >}}Nginx Management Suite v2.18.0 or lower: The Security Monitoring module doesn’t automatically install or upgrade NGINX Instance Manager. You’ll need to manually install or upgrade NGINX Instance Manager to a supported version.
{{< /note >}}

{{< note >}}Nginx Instance Manager v2.19.0 or higher: The Security Monitoring module is one of the in-built feature of Nginx Instance Manager. You'll need not to manually install or upgrade NGINX Instance Manager to a supported version.
{{< /note >}}

{{<bootstrap-table "table table-striped table-bordered">}}
Expand Down
28 changes: 15 additions & 13 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,12 +55,14 @@ The table below shows which WAF compiler version to use for each version of NGIN

| NGINX App Protect WAF version | WAF compiler version |
|-------------------------------|----------------------------|
| 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.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 |
Expand All @@ -86,13 +88,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.342.0
sudo apt-get install nms-nap-compiler-v5.442.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.342.0 -o Dpkg::Options::="--force-overwrite"
sudo apt-get install nms-nap-compiler-v5.442.0 -o Dpkg::Options::="--force-overwrite"
```

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

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

4. {{< include "nim/nap-waf/restart-nms-integrations.md" >}}
Expand All @@ -140,7 +142,7 @@ To install the WAF compiler on RHEL 7.4 or later or CentOS:
3. Install the WAF compiler:

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

4. {{< include "nim/nap-waf/restart-nms-integrations.md" >}}
Expand All @@ -167,7 +169,7 @@ To install the WAF compiler on Amazon Linux 2 LTS:
3. Install the WAF compiler:

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

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

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

4. {{< include "nim/nap-waf/restart-nms-integrations.md" >}}
Expand Down Expand Up @@ -1004,21 +1006,21 @@ sudo /opt/nms-nap-compiler/app_protect-<version>/bin/apcompile -h
**Example:**

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

**Expected output:**

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

Examples:
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -p /path/to/policy.json -o mypolicy.tgz
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -p policyA.json -g myglobal.json -o /path/to/policyA_bundle.tgz
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -g myglobalsettings.json --global-state-outfile /path/to/myglobalstate.tgz
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -b /path/to/policy_bundle.tgz --dump
/opt/nms-nap-compiler/app_protect-5.342.0/bin/apcompile -l logprofA.json -o /path/to/logprofA_bundle.tgz
/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
```

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