Skip to content

Commit 562683e

Browse files
committed
Internal/nim release 2.21.0 (#272)
* updated docs for bot signatures * edits from tech review * Reorganized the NIM WAF docs * moved files to subdirs and fixed links * Renamed NGINX App Protect to F5 WAF for NGINX in the NIM docs * made separate topics for security policies and fixed links * broke up the manage waf security policies doc into separate topics * deleted manage-waf-security-policies.md file * cleaned up waf policy doc titles * created include for F5 WAF compiler compatibility * edits to waf compiler heading levels * updates to NIM WAF docs * changed weight of Add signature sets and exceptions * edits to NIM WAF front matter * edits to NAP WAF topic titles * edits * fixes URL in front-matter metadata * edits * edits * Deleted file that was inadvertently added * edits * edits per tech review * edits * edits * edits * added release notes and known issues for NIM 2.21.0. * edits * edits * edits to NIM WAF version requirements * edits * edits per tech review * fixed url path in nim index files * edit per tech review * fixed bullet indenting * added known issue for 46754 * changed bash codeblocks to shell * fixed broken links * fixed url path for security monitoring * bumped NIM NAP WAF support table for 2.21.0 * fixed link * added release note for 46726
1 parent 55ef924 commit 562683e

File tree

108 files changed

+3560
-2282
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+3560
-2282
lines changed

content/includes/agent/installation/install-agent-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
nd-docs: DOCS-1031
33
files:
4-
- content/nim/nginx-app-protect/setup-waf-config-management.md
4+
- content/nim/waf-integration/configuration/setup-waf-config-management.md
55
---
66

77
{{< call-out "note" >}}Make sure `gpg` is installed on your system before continuing. You can install NGINX Agent using command-line tools like `curl` or `wget`.{{< /call-out >}}

content/includes/nim/admin-guide/auth/basic-auth-api-requests.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ nd-docs: DOCS-1295
44

55
To use basic authentication for API requests, include your base64-encoded credentials as a "Basic" token in the "Authorization" header. To create the base64-encoded credentials, run the following command:
66

7-
```bash
7+
```shell
88
echo -n <username>:<password> | base64
99
```
1010

1111
Once you've generated the credentials, you can include them in your API request. Here's how to do it with `curl`:
1212

13-
```bash
13+
```shell
1414
curl -X GET "https://<NIM_FQDN>/api/platform/<API_VERSION>/systems" -H "Authorization: Basic <base64_encoded_credentials>"
1515
```
1616

content/includes/nim/disconnected/set-mode-of-operation-disconnected.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ nd-docs: "DOCS-1663"
1212
1313
2. Restart NGINX Instance Manager:
1414
15-
``` bash
15+
```shell
1616
sudo systemctl restart nms
1717
```

content/includes/nim/docker/docker-registry-login.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nd-docs: "DOCS-1666"
1212

1313
2. Log in to the Docker registry using the contents of the JSON Web Token file:
1414

15-
```bash
15+
```shell
1616
docker login private-registry.nginx.com --username=<JWT_CONTENTS> --password=none
1717
```
1818

content/includes/nim/how-to-access-api-docs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
nd-docs: DOCS-991
33
---
44

5-
You can access the NGINX Instance Manager API documentation from the web interface:
5+
Access the NGINX Instance Manager API documentation from the web interface:
66

7-
1. Log in to the FQDN of your NGINX Instance Manager host.
8-
2. Select **API Documentation** from the Launchpad menu.
9-
3. On the left menu, select **NIM and Platform API**.
7+
1. Go to the FQDN of your NGINX Instance Manager host and log in.
8+
2. From the Launchpad menu, select **API Documentation**.
9+
3. In the left menu, choose **NIM and Platform API**.

content/includes/nim/how-to-access-nim-api.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
nd-docs: DOCS-1050
33
---
44

5-
You can use tools like `curl` or [Postman](https://www.postman.com) to interact with the NGINX Instance Manager REST API. The API URL is `https://<NIM-FQDN>/api/[nim|platform]/<API_VERSION>`, and each request requires authentication. For more details on authentication options, see the [API Overview]({{< ref "/nim/fundamentals/api-overview.md" >}}).
5+
Use tools such as `curl` or [Postman](https://www.postman.com) to send requests to the NGINX Instance Manager REST API.
6+
The API base URL is `https://<NIM-FQDN>/api/[nim|platform]/<API_VERSION>`.
7+
All requests require authentication. For details on authentication methods, see the [API overview]({{< ref "/nim/fundamentals/api-overview.md" >}}).

content/includes/nim/kubernetes/access-webui-helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ You can access the NGINX Instance Manager web interface using the external IP ad
66

77
1. To look up the external IP address for the API Gateway, run the following command:
88

9-
```bash
9+
```shell
1010
kubectl -n nim get svc apigw
1111
```
1212

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
docs:
3+
files:
4+
- /nim/security-monitoring/update-signatures.md
5+
---
6+
7+
1. Open an SSH connection to the data plane host and log in.
8+
1. Generate a Signature Report file using the [Attack Signature Report Tool]({{< ref "/waf/configure/converters.md#attack-signature-report-tool" >}}). Save the file as `signature-report.json`:
9+
10+
```shell
11+
sudo /opt/app_protect/bin/get-signatures -o ./signature-report.json
12+
```
13+
14+
1. Open an SSH connection to the management plane host and log in.
15+
1. Copy the `signature-report.json` file to the NGINX Instance Manager control plane at `/usr/share/nms/sigdb/`:
16+
17+
```shell
18+
sudo scp /path/to/signature-report.json {user}@{host}:/usr/share/nms/sigdb/signature-report.json
19+
```
20+
21+
1. Restart the NGINX Instance Manager services to apply the update:
22+
23+
```shell
24+
sudo systemctl restart nms-ingestion
25+
sudo systemctl restart nms-core
26+
```

content/includes/nim/system-configuration/trust-proxy-ca-certificates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
- **Debian/Ubuntu**:
88

9-
```bash
9+
```shell
1010
sudo update-ca-certificates
1111
```
1212

content/includes/nim/tech-specs/nim-app-protect-support.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
nd-docs: DOCS-1068
33
---
44

5-
NGINX Instance Manager supports the following versions of [F5 WAF for NGINX](https://docs.nginx.com/nginx-app-protect/):
5+
NGINX Instance Manager supports the following versions of [F5 WAF for NGINX](https://docs.nginx.com/waf/):
66

7-
{{<bootstrap-table "table table-striped table-bordered">}}
7+
{{< table >}}
88

9-
| NGINX Instance Manager | F5 WAF for NGINX |
10-
|------------------------|------------------------------------|
11-
| 2.17.0–2.20.0 | Release 4.8.0–4.16.0, 5.1.0–5.9.0 |
9+
| NGINX Instance Manager | F5 WAF for NGINX |
10+
| ---------------------- | --------------------------------- |
11+
| 2.17.0–2.21.0 | Release 4.8.0–4.16.0, 5.1.0–5.9.0 |
1212
| 2.15.1–2.16.0 | Release 4.8.0–4.10.0 |
1313
| 2.14.1–2.15.0 | Release 4.4.0–4.7.0 |
1414
| 2.13.0–2.14.0 | Release 4.3.0–4.5.0 |
@@ -20,5 +20,4 @@ NGINX Instance Manager supports the following versions of [F5 WAF for NGINX](htt
2020
| 2.7.0 | Release 3.12.2–4.0.0 |
2121
| 2.6.0 | Release 3.12.2 |
2222

23-
{{</bootstrap-table>}}
24-
23+
{{</ table >}}

0 commit comments

Comments
 (0)