Skip to content

Commit 244dc0f

Browse files
committed
feat: Update versioning based on feedback
1 parent bb0b7c4 commit 244dc0f

File tree

4 files changed

+19
-139
lines changed

4 files changed

+19
-139
lines changed

content/nap-waf/v4/admin-guide/install.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,9 @@ NGINX App Protect WAF supports the following operating systems:
4040
- [Ubuntu 20.04 (Focal)](#ubuntu-1804--ubuntu-2004--ubuntu-2204--ubuntu-2404-installation)
4141
- [Ubuntu 22.04 (Jammy)](#ubuntu-1804--ubuntu-2004--ubuntu-2204--ubuntu-2404-installation)
4242
- [Ubuntu 24.04 (Noble)](#ubuntu-1804--ubuntu-2004--ubuntu-2204--ubuntu-2404-installation)
43-
- [Alpine 3.16](#alpine-316-317--319-installation) - (Deprecated starting from NGINX Plus R33)
4443
- [Alpine 3.17](#alpine-316-317--319-installation)
4544
- [Alpine 3.19](#alpine-316-317--319-installation)
4645

47-
4846
The NGINX App Protect WAF package has the following dependencies:
4947

5048
1. **nginx-plus-module-appprotect** - NGINX Plus dynamic module for App Protect
@@ -1808,8 +1806,8 @@ CMD ["sh", "/root/entrypoint.sh"]
18081806
18091807
```dockerfile
18101808
# syntax=docker/dockerfile:1
1811-
# For Alpine 3.16 / 3.17 / 3.19:
1812-
FROM alpine:3.16/3.17/3.19
1809+
# For Alpine 3.16/3.17/3.19:
1810+
FROM alpine:3.19
18131811
18141812
# Download and add the NGINX signing keys:
18151813
RUN wget -O /etc/apk/keys/nginx_signing.rsa.pub https://cs.nginx.com/static/keys/nginx_signing.rsa.pub \
@@ -2210,7 +2208,7 @@ RUN --mount=type=secret,id=nginx-crt,dst=/etc/ssl/nginx/nginx-repo.crt,mode=0644
22102208
```dockerfile
22112209
# syntax=docker/dockerfile:1
22122210
# For Alpine 3.16/3.17/3.19:
2213-
FROM alpine:3.16/3.17/3.19
2211+
FROM alpine:3.19
22142212
22152213
# Download and add the NGINX signing keys:
22162214
RUN wget -O /etc/apk/keys/nginx_signing.rsa.pub https://cs.nginx.com/static/keys/nginx_signing.rsa.pub \

content/nap-waf/v4/releases/about-4.13.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ January 30th, 2025
1717

1818
- Added support for Alpine 3.19
1919
- Added support for [Brute force attack preventions]({{< ref "/nap-waf/v4/configuration-guide/configuration.md#brute-force-attack-preventions" >}})
20-
- Enforcer can now upgrade without requiring policies to be recompiled
2120

2221
---
2322

content/nap-waf/v5/admin-guide/install.md

Lines changed: 15 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -35,24 +35,15 @@ If not already installed, `nginx` or `nginx-plus` will be installed automaticall
3535

3636
### Common Steps for NGINX Open Source and NGINX Plus
3737
Please follow these steps before you install either NGINX Open Source or NGINX Plus.
38+
3839
{{<tabs name="common_steps_for_nginx_oss_and_plus">}}
39-
{{%tab name="Alpine Linux 3.16"%}}
40-
41-
{{< include "nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-alpine" >}}
4240

43-
{{%/tab%}}
44-
{{%tab name="Alpine Linux 3.17"%}}
41+
{{%tab name="Alpine Linux 3.16/3.17/3.19"%}}
4542

4643
{{< include "nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-alpine" >}}
4744

4845
{{%/tab%}}
4946

50-
{{%tab name="Alpine Linux 3.19"%}}
51-
52-
{{< include "nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-alpine" >}}
53-
54-
{{%/tab%}}
55-
5647
{{%tab name="Amazon Linux 2"%}}
5748

5849
1. Create the `/etc/ssl/nginx` directory:
@@ -136,32 +127,10 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
136127
{{</tabs>}}
137128

138129
### For NGINX Open Source
139-
{{<tabs name="for_nginx_open_source">}}
140-
{{%tab name="Alpine Linux 3.16"%}}
141-
142-
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}
143-
144-
3. Install the NGINX App Protect WAF v5 package:
145-
146-
```shell
147-
sudo apk add app-protect-module-oss
148-
```
149-
150-
{{%/tab%}}
151-
152-
{{%tab name="Alpine Linux 3.17"%}}
153-
154-
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}
155-
156-
3. Install the NGINX App Protect WAF v5 package:
157-
158-
```shell
159-
sudo apk add app-protect-module-oss
160-
```
161130

162-
{{%/tab%}}
131+
{{<tabs name="for_nginx_open_source">}}
163132

164-
{{%tab name="Alpine Linux 3.19"%}}
133+
{{%tab name="Alpine Linux 3.16/3.17/3.19"%}}
165134

166135
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}
167136

@@ -333,30 +302,8 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
333302

334303
### For NGINX Plus
335304
{{<tabs name="for_nginx_plus">}}
336-
{{%tab name="Alpine Linux 3.16"%}}
337305

338-
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-alpine.md" >}}
339-
340-
3. Install the NGINX App Protect WAF v5 package:
341-
342-
```shell
343-
sudo apk add app-protect-module-plus
344-
```
345-
346-
{{%/tab%}}
347-
{{%tab name="Alpine Linux 3.17"%}}
348-
349-
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-alpine.md" >}}
350-
351-
3. Install the NGINX App Protect WAF v5 package:
352-
353-
```shell
354-
sudo apk add app-protect-module-plus
355-
```
356-
357-
{{%/tab%}}
358-
359-
{{%tab name="Alpine Linux 3.19"%}}
306+
{{%tab name="Alpine Linux 3.16/3.17/3.19"%}}
360307

361308
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-alpine.md" >}}
362309

@@ -660,18 +607,17 @@ If not already installed, `nginx` or `nginx-plus` will be installed automaticall
660607
{{< /note >}}
661608
662609
### Common Steps for NGINX Open Source and NGINX Plus
610+
663611
Please follow these steps before you install either NGINX Open Source or NGINX Plus.
612+
664613
{{<tabs name="offline_common_steps_for_nginx_oss_and_plus">}}
665-
{{%tab name="Alpine Linux 3.16"%}}
666-
667-
{{< include "nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-alpine" >}}
668614
669-
{{%/tab%}}
670-
{{%tab name="Alpine Linux 3.17"%}}
615+
{{%tab name="Alpine Linux 3.16/3.17/3.19"%}}
671616
672617
{{< include "nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-alpine" >}}
673618
674619
{{%/tab%}}
620+
675621
{{%tab name="Amazon Linux 2023"%}}
676622
677623
{{< include "nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-amzn2023.md" >}}
@@ -720,7 +666,9 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
720666
{{</tabs>}}
721667
722668
### For NGINX Open Source
669+
723670
{{<tabs name="offline_for_nginx_open_source">}}
671+
724672
{{%tab name="Alpine Linux 3.16"%}}
725673
726674
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}
@@ -948,35 +896,10 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
948896
{{</tabs>}}
949897
950898
### For NGINX Plus
951-
{{<tabs name="offline_for_nginx_plus">}}
952-
{{%tab name="Alpine Linux 3.16"%}}
953-
954-
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-alpine.md" >}}
955-
956-
3. Download all NGINX Plus packages, including all dependencies:
957-
958-
```shell
959-
sudo mkdir /etc/packages/
960-
sudo apk update
961-
sudo apk fetch --recursive --output /etc/packages app-protect-module-plus
962-
```
963-
964-
{{%/tab%}}
965-
{{%tab name="Alpine Linux 3.17"%}}
966-
967-
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-alpine.md" >}}
968-
969-
3. Download all NGINX Plus packages, including all dependencies:
970899
971-
```shell
972-
sudo mkdir /etc/packages/
973-
sudo apk update
974-
sudo apk fetch --recursive --output /etc/packages app-protect-module-plus
975-
```
976-
977-
{{%/tab%}}
900+
{{<tabs name="offline_for_nginx_plus">}}
978901
979-
{{%tab name="Alpine Linux 3.19"%}}
902+
{{%tab name="Alpine Linux 3.16/3.17/3.19"%}}
980903
981904
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-alpine.md" >}}
982905
@@ -1328,43 +1251,10 @@ sudo docker compose stop
13281251
```
13291252

13301253
### Uninstall the NGINX App Protect WAF v5 Package
1331-
{{<tabs name="uninstall_nginx_and_nginx_nap">}}
1332-
{{%tab name="Alpine Linux 3.16"%}}
1333-
1334-
For NGINX Open Source
1335-
Uninstall the NGINX App Protect WAF v5 package:
1336-
1337-
```shell
1338-
sudo apk del app-protect-module-oss
1339-
```
1340-
1341-
For NGINX Plus
1342-
Uninstall the NGINX App Protect WAF v5 package:
13431254

1344-
```shell
1345-
sudo apk del app-protect-module-plus
1346-
```
1347-
1348-
{{%/tab%}}
1349-
{{%tab name="Alpine Linux 3.17"%}}
1350-
1351-
For NGINX Open Source
1352-
Uninstall the NGINX App Protect WAF v5 package:
1353-
1354-
```shell
1355-
sudo apk del app-protect-module-oss
1356-
```
1357-
1358-
For NGINX Plus
1359-
Uninstall the NGINX App Protect WAF v5 package:
1360-
1361-
```shell
1362-
sudo apk del app-protect-module-plus
1363-
```
1364-
1365-
{{%/tab%}}
1255+
{{<tabs name="uninstall_nginx_and_nginx_nap">}}
13661256

1367-
{{%tab name="Alpine Linux 3.19"%}}
1257+
{{%tab name="Alpine Linux 3.16/3.17/3.19"%}}
13681258

13691259
For NGINX Open Source
13701260
Uninstall the NGINX App Protect WAF v5 package:

content/nap-waf/v5/configuration-guide/configuration.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -791,8 +791,6 @@ To enable mTLS in NGINX, you need to perform the following steps:
791791

792792
## Brute Force Attack Preventions
793793

794-
### Overview
795-
796794
Brute force attacks are attempts to break in to secured areas of a web application by trying exhaustive,
797795
systematic, username/password combinations to discover legitimate authentication credentials.
798796
To prevent brute force attacks, WAF tracks the number of failed attempts to reach login pages
@@ -839,7 +837,7 @@ if failed logins reached a maximum threshold.
839837
}
840838

841839
```
842-
### brute-force-attack-preventions fields description
840+
### Brute force attack fields description
843841

844842
bruteForceProtectionForAllLoginPages:
845843
When enabled, enables Brute Force Protection for all configured login URLs.
@@ -851,9 +849,6 @@ if failed logins reached a maximum threshold.
851849
Specifies action that is applied when the defined thresholds ( failedLoginAttemptsRateReached) is reached.
852850
- **alarm**: The system will log the login attempt.
853851

854-
detectDistributedBruteForceAttack:
855-
When enabled, the system detects distributed brute force attacks.
856-
857852
failedLoginAttemptsRateReached:
858853
After configured threshold (number of failed login attempts within measurementPeriod) defined action will be applied for the next login attempt.
859854

@@ -971,7 +966,6 @@ if failed logins reached a maximum threshold.
971966

972967
This table summarizes the nginx.conf directives for NGINX App Protect WAF functionality.
973968

974-
{{<bootstrap-table "table table-striped table-bordered table-sm table-responsive">}}
975969
|Directive Name | Syntax | Functionality | nginx.conf Contexts | Example |
976970
| ---| ---| ---| ---| --- |
977971
|load_module | load_module <library_file_path> | NGINX directive to load the App Protect module. It must be invoked with the App Protect library path | Global | load_module modules/ngx_http_app_protect_module.so |
@@ -981,7 +975,6 @@ This table summarizes the nginx.conf directives for NGINX App Protect WAF functi
981975
|app_protect_security_log_enable | app_protect_security_log_enable on &#124; off | Whether to enable the App Protect per-request log at the respective context. | HTTP, Server, Location | app_protect_security_log_enable on |
982976
|app_protect_security_log | app_protect_security_log <file_path> <destination> | Specifies the per-request logging: what to log and where | HTTP, Server, Location | app_protect_security_log /config/waf/log_illegal.tgz syslog:localhost:522 |
983977
|app_protect_custom_log_attribute | app_protect_custom_log_attribute <key_value> | Specifies the assigned location/server/http dimension of each request. | HTTP, Server, Location | app_protect_custom_log_attribute ‘environment' 'env1' |
984-
{{</bootstrap-table>}}
985978

986979
#### Failure Mode
987980

0 commit comments

Comments
 (0)