Skip to content

Commit 97e8255

Browse files
authored
fix: last minute changes
1 parent 118a1fd commit 97e8255

File tree

1 file changed

+98
-41
lines changed

1 file changed

+98
-41
lines changed

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

Lines changed: 98 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ NGINX App Protect WAF supports the following operating systems:
3232
- [Debian 11 (Bullseye) & 12 (Bookworm)](#debian-10--debian-11--debian-12-installation)
3333
- [Oracle Linux 8.1.x and above](#oracle-linux-81-installation)
3434
- [RHEL 8.1.x and above](#rhel-81-installation)
35-
- [RHEL 9, Rocky Linux 9 and above](#rhel-9-installation)
36-
- [Ubuntu 22.04 (Jammy) & 24.04 (Noble)](#ubuntu-installation)
35+
- [RHEL 9 and above](#rhel-9-installation)
36+
- [Ubuntu 20.04 (Focal), 22.04 (Jammy) & 24.04 (Noble)](#ubuntu-installation)
3737

3838
The NGINX App Protect WAF package has the following dependencies:
3939

@@ -216,7 +216,7 @@ If a user other than **nginx** is to be used, note the following:
216216
sudo service nginx start
217217
```
218218

219-
14. As of version 4.15.0, a new feature feature `IP Intelligence` is available. The feature requires the installation of an additional package to function properly:
219+
14. (Optional) A new feature feature `IP Intelligence` is available (version 4.15.0 and above). The feature requires the installation of an additional package to function properly:
220220

221221
```shell
222222
sudo apk add app-protect-ip-intelligence
@@ -228,6 +228,11 @@ If a user other than **nginx** is to be used, note the following:
228228
/opt/app_protect/bin/iprepd /etc/app_protect/tools/iprepd.cfg > ipi.log 2>&1 &
229229
```
230230

231+
Update your policy to include the new configuration, then restart the nginx service:
232+
```shell
233+
service nginx restart
234+
```
235+
231236
---
232237

233238
## Amazon Linux Installation
@@ -342,17 +347,22 @@ If a user other than **nginx** is to be used, note the following:
342347
sudo systemctl start nginx
343348
```
344349

345-
1. As of version 4.15.0, a new feature feature `IP Intelligence` is available. The feature requires the installation of an additional package to function properly:
350+
1. (Optional) A new feature feature `IP Intelligence` is available (version 4.15.0 and above). The feature requires the installation of an additional package to function properly:
346351

347352
```shell
348-
sudo dnf install app-protect-ip-intelligence
353+
sudo dnf install -y app-protect-ip-intelligence
349354
```
350355

351356
After installing the package, run the client:
352357

353358
```shell
354359
/opt/app_protect/bin/iprepd /etc/app_protect/tools/iprepd.cfg > ipi.log 2>&1 &
355360
```
361+
362+
Update your policy to include the new configuration, then restart the nginx service:
363+
```shell
364+
service nginx restart
365+
```
356366

357367
## Debian Installation
358368

@@ -493,17 +503,23 @@ If a user other than **nginx** is to be used, note the following:
493503
sudo systemctl start nginx
494504
```
495505
496-
16. As of version 4.15.0, a new feature feature `IP Intelligence` is available. The feature requires the installation of an additional package to function properly:
506+
16. (Optional) A new feature feature `IP Intelligence` is available (version 4.15.0 and above). The feature requires the installation of an additional package to function properly:
497507
498508
```shell
499-
sudo apt install app-protect-ip-intelligence
509+
sudo apt-get -y install app-protect-ip-intelligence
500510
```
501511
502512
After installing the package, run the client:
503513
504514
```shell
505515
/opt/app_protect/bin/iprepd /etc/app_protect/tools/iprepd.cfg > ipi.log 2>&1 &
506516
```
517+
518+
Update your policy to include the new configuration, then restart the nginx service:
519+
520+
```shell
521+
service nginx restart
522+
```
507523
508524
{{< warning >}} Debian enables **AppArmor** by default, but NGINX App Protect WAF will run in unconfined mode after being installed as it is shipped with no AppArmor profile. To benefit from AppArmor access control capabilities for NGINX App Protect WAF, you will have to write your own AppArmor profile for NGINX App Protect WAF executables found in `/opt/app_protect/bin` such that it best suits your environment.
509525
{{< /warning >}}
@@ -626,21 +642,27 @@ If a user other than **nginx** is to be used, note the following:
626642
sudo systemctl start nginx
627643
```
628644

629-
17. As of version 4.15.0, a new feature feature `IP Intelligence` is available. The feature requires the installation of an additional package to function properly:
645+
17. (Optional) A new feature feature `IP Intelligence` is available (version 4.15.0 and above). The feature requires the installation of an additional package to function properly:
630646

631647
```shell
632-
sudo dnf install app-protect-ip-intelligence
648+
sudo dnf install -y app-protect-ip-intelligence
633649
```
634650

635651
After installing the package, run the client:
636652

637653
```shell
638654
/opt/app_protect/bin/iprepd /etc/app_protect/tools/iprepd.cfg > ipi.log 2>&1 &
639655
```
656+
657+
Update your policy to include the new configuration, then restart the nginx service:
658+
659+
```shell
660+
service nginx restart
661+
```
640662

641663
---
642664

643-
## RHEL 9+ / Rocky Linux 9 Installation
665+
## RHEL 9+ Installation
644666

645667
1. If you already have NGINX packages in your system, back up your configs and logs:
646668

@@ -666,13 +688,6 @@ If a user other than **nginx** is to be used, note the following:
666688
667689
5. Install prerequisite packages:
668690
669-
- For Rocky Linux:
670-
```shell
671-
sudo dnf -y install wget ca-certificates 'dnf-command(config-manager)'
672-
sudo dnf config-manager --set-enabled crb
673-
sudo dnf install ca-certificates wget
674-
```
675-
- For RHEL
676691
```shell
677692
sudo dnf install ca-certificates wget
678693
```
@@ -765,10 +780,10 @@ If a user other than **nginx** is to be used, note the following:
765780
sudo systemctl start nginx
766781
```
767782

768-
1. As of version 4.15.0, a new feature feature `IP Intelligence` is available. The feature requires the installation of an additional package to function properly:
783+
1. (Optional) A new feature feature `IP Intelligence` is available (version 4.15.0 and above). The feature requires the installation of an additional package to function properly:
769784

770785
```shell
771-
sudo dnf install app-protect-ip-intelligence
786+
sudo dnf install -y app-protect-ip-intelligence
772787
```
773788

774789
After installing the package, run the client:
@@ -777,6 +792,11 @@ If a user other than **nginx** is to be used, note the following:
777792
/opt/app_protect/bin/iprepd /etc/app_protect/tools/iprepd.cfg > ipi.log 2>&1 &
778793
```
779794

795+
Update your policy to include the new configuration, then restart the nginx service:
796+
```shell
797+
service nginx restart
798+
```
799+
780800
---
781801

782802
## Ubuntu Installation
@@ -877,7 +897,7 @@ If a user other than **nginx** is to be used, note the following:
877897
app-protect=23+3.263.0-1~[OS_CODENAME]
878898
```
879899
880-
Replace the [OS_CODENAME] in above the example with **jammy** for Ubuntu 22.04 and **noble** for Ubuntu 24.04.
900+
Replace the [OS_CODENAME] in above the example with **focal** for Ubuntu 20.04, **jammy** for Ubuntu 22.04 and **noble** for Ubuntu 24.04.
881901
<br>
882902
<br>
883903
@@ -912,10 +932,10 @@ If a user other than **nginx** is to be used, note the following:
912932
sudo systemctl start nginx
913933
```
914934
915-
16. As of version 4.15.0 (not avaiable for the deprecated Ubuntu 20.04), a new feature `IP Intelligence` is available. The feature requires the installation of an additional package to function properly:
935+
16. (Optional), a new feature `IP Intelligence` is supported (Check the release notes for the App Protect versions that support IP Intelligence). The feature requires the installation of an additional package to function properly:
916936
917937
```shell
918-
sudo apt install app-protect-ip-intelligence
938+
sudo apt-get -y install app-protect-ip-intelligence
919939
```
920940
921941
After installing the package, run the client:
@@ -924,7 +944,15 @@ If a user other than **nginx** is to be used, note the following:
924944
/opt/app_protect/bin/iprepd /etc/app_protect/tools/iprepd.cfg > ipi.log 2>&1 &
925945
```
926946
927-
{{< note >}} Ubuntu 22.04 / Ubuntu 24.04 activates **AppArmor** by default, but NGINX App Protect WAF will run in unconfined mode after being installed as it is shipped with no AppArmor profile. To benefit from AppArmor access control capabilities for NGINX App Protect WAF, you will have to write your own AppArmor profile for NGINX App Protect WAF executables found in `/opt/app_protect/bin` such that it best suits your environment.
947+
Verify the client is populating the database:
948+
949+
```shell
950+
tail -f iprepd.log
951+
```
952+
953+
Update your policy to include the new configuration for IP Intelligence, then reload the policy or restart the nginx service.
954+
955+
{{< note >}} Ubuntu 20.04 / Ubuntu 22.04 / Ubuntu 24.04 activates **AppArmor** by default, but NGINX App Protect WAF will run in unconfined mode after being installed as it is shipped with no AppArmor profile. To benefit from AppArmor access control capabilities for NGINX App Protect WAF, you will have to write your own AppArmor profile for NGINX App Protect WAF executables found in `/opt/app_protect/bin` such that it best suits your environment.
928956
{{< /note >}}
929957
930958
## Docker Deployments
@@ -1340,7 +1368,7 @@ CMD ["sh", "/root/entrypoint.sh"]
13401368
ARG OS_CODENAME
13411369
# Where OS_CODENAME can be: focal/jammy/noble
13421370
# syntax=docker/dockerfile:1
1343-
# For Ubuntu 22.04 / 24.04:
1371+
# For Ubuntu 20.04 / 22.04 / 24.04:
13441372
FROM ubuntu:${OS_CODENAME}
13451373
13461374
# Install prerequisite packages:
@@ -1671,13 +1699,13 @@ RUN --mount=type=secret,id=nginx-crt,dst=/etc/ssl/nginx/nginx-repo.crt,mode=0644
16711699
apt-get update && DEBIAN_FRONTEND="noninteractive" apt-get install -y app-protect-compiler
16721700
```
16731701
1674-
### Ubuntu 22.04 / Ubuntu 24.04 Converter Docker Deployment Example
1702+
### Ubuntu 20.04 / Ubuntu 22.04 / Ubuntu 24.04 Converter Docker Deployment Example
16751703
16761704
```dockerfile
16771705
ARG OS_CODENAME
16781706
# Where OS_CODENAME can be: bionic/focal/jammy/noble
16791707
# syntax=docker/dockerfile:1
1680-
# For Ubuntu 22.04 / 24.04:
1708+
# For Ubuntu 20.04 /22.04 / 24.04:
16811709
FROM ubuntu:${OS_CODENAME}
16821710
16831711
# Install prerequisite packages:
@@ -1764,7 +1792,7 @@ For RHEL 8.1+ / Oracle Linux 8.1+:
17641792
wget -P /etc/packages https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
17651793
```
17661794
1767-
For RHEL 9+ / Rocky Linux 9:
1795+
For RHEL 9+:
17681796
17691797
```shell
17701798
wget -P /etc/packages https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
@@ -1826,7 +1854,6 @@ On an offline host:
18261854
apt-get update
18271855
apt-get install -y app-protect
18281856
```
1829-
18301857
Only use if you want to install and use the IP intelligence feature:
18311858
18321859
```shell
@@ -1969,7 +1996,7 @@ After having updated the Attack Signature package you have to reload the configu
19691996
sudo dnf downgrade app-protect-attack-signatures-2019.07.16
19701997
```
19711998
1972-
### RHEL 9+ / Rocky Linux 9
1999+
### RHEL 9+
19732000
19742001
1. To add NGINX App Protect WAF Security Updates repository, download the file `app-protect-9.repo` to `/etc/yum.repos.d`:
19752002
@@ -2048,7 +2075,7 @@ For Debian 12:
20482075
sudo apt-get install app-protect-attack-signatures=2020.04.30-1~bookworm
20492076
```
20502077
2051-
### Ubuntu 22.04 / Ubuntu 24.04
2078+
### Ubuntu 20.04 / Ubuntu 22.04
20522079
20532080
1. Add NGINX App Protect WAF Security Updates repository:
20542081
@@ -2083,6 +2110,12 @@ sudo apt-get install app-protect-attack-signatures=2020.04.30-1~bookworm
20832110
sudo apt-cache policy app-protect-attack-signatures
20842111
```
20852112
2113+
For Ubuntu 20.04:
2114+
2115+
```shell
2116+
sudo apt-get install app-protect-attack-signatures=2020.07.16-1~focal
2117+
```
2118+
20862119
For Ubuntu 22.04:
20872120
20882121
```shell
@@ -2190,7 +2223,7 @@ Example: app-protect-threat-campaigns-2022.07.21
21902223
sudo dnf install app-protect-threat-campaigns-2022.07.21
21912224
```
21922225
2193-
### RHEL 9+ / Rocky Linux 9
2226+
### RHEL 9+
21942227
21952228
1. If not already configured, add NGINX App Protect WAF Security Updates repository by downloading the file `app-protect-9.repo` to `/etc/yum.repos.d`:
21962229
@@ -2295,7 +2328,7 @@ sudo apt-get install app-protect-threat-campaigns=2020.06.25-1~bullseye
22952328
sudo apt-get install app-protect-threat-campaigns=2020.06.25-1~bookworm
22962329
```
22972330
2298-
### Ubuntu 22.04
2331+
### Ubuntu 20.04 / Ubuntu 22.04
22992332
23002333
1. If not already configured, add the NGINX App Protect WAF Security Updates repository:
23012334
@@ -2386,7 +2419,7 @@ The App Protect Bot Signatures is named: app-protect-bot-signatures and it is a
23862419
sudo dnf downgrade app-protect-bot-signatures-2023.11.14
23872420
```
23882421
2389-
### RHEL 9+ / Rocky Linux 9
2422+
### RHEL 9+
23902423
23912424
1. If not already configured, add NGINX App Protect WAF Security Updates repository by downloading the file `app-protect-9.repo` to `/etc/yum.repos.d`:
23922425
@@ -2501,7 +2534,7 @@ The App Protect Bot Signatures is named: app-protect-bot-signatures and it is a
25012534
```
25022535
25032536
2504-
### Ubuntu 22.04
2537+
### Ubuntu 20.04 / Ubuntu 22.04
25052538
25062539
1. If not already configured, add the NGINX App Protect WAF Security Updates repository:
25072540
@@ -2573,13 +2606,29 @@ In case of using the prebuilt SELinux policy module for NGINX App Protect WAF (a
25732606
25742607
You can uninstall the App Protect in below Operating Systems by using the following commands:
25752608
2576-
### RHEL 8.1+ / Oracle Linux 8.1+ / RHEL 9+ / Rocky Linux 9
2609+
### RHEL 8.1+ / Oracle Linux 8.1+ / RHEL 9+
2610+
2611+
If you have previously installed `app-protect-ip-intelligence` package, please make sure to uninstall it first:
2612+
2613+
```shell
2614+
sudo dnf remove app-protect-ip-intelligence
2615+
```
2616+
2617+
Then proceed with uninstalling App Protect packages:
25772618
25782619
```shell
25792620
sudo dnf remove app-protect app-protect-selinux
25802621
```
25812622
2582-
### Debian 11 / Debian 12 / Ubuntu 22.04 / Ubuntu 24.04
2623+
### Debian 11 / Debian 12 / Ubuntu 20.04 / Ubuntu 22.04 / Ubuntu 24.04
2624+
2625+
If you have previously installed `app-protect-ip-intelligence` package, please make sure to uninstall it first:
2626+
2627+
```shell
2628+
sudo apt-get remove app-protect-ip-intelligence
2629+
```
2630+
2631+
Then proceed with uninstalling App Protect packages:
25832632
25842633
```shell
25852634
sudo apt-get remove app-protect \
@@ -2596,6 +2645,14 @@ app-protect-bot-signatures
25962645
25972646
### Alpine 3.16 / Alpine 3.17 / Alpine 3.19
25982647
2648+
If you have previously installed `app-protect-ip-intelligence` package, please make sure to uninstall it first:
2649+
2650+
```shell
2651+
sudo apk del app-protect-ip-intelligence
2652+
```
2653+
2654+
Then proceed with uninstalling App Protect packages:
2655+
25992656
```shell
26002657
sudo apk del app-protect \
26012658
app-protect-plugin \
@@ -2611,7 +2668,7 @@ app-protect-bot-signatures
26112668
26122669
## Upgrading App Protect to a Specific Version
26132670
2614-
### RHEL 8.1+ / Oracle Linux 8.1+ / RHEL 9+ / Rocky Linux 9
2671+
### RHEL 8.1+ / Oracle Linux 8.1+ / RHEL 9+
26152672
26162673
1. Upgrade the NGINX App Protect WAF to the specific version:
26172674
@@ -2641,7 +2698,7 @@ app-protect=27+3.1088.2-1~[OS_CODENAME]
26412698
26422699
**Note**: Replace the [OS_CODENAME] in the above command with **bullseye** for Debian 11 and **bookworm** for Debian 12.
26432700
2644-
### Ubuntu 22.04
2701+
### Ubuntu 20.04 / Ubuntu 22.04
26452702
26462703
1. Get the dependencies and their versions to be upgraded to by using the command:
26472704
@@ -2661,19 +2718,19 @@ app-protect=27+3.1088.2-1~[OS_CODENAME]
26612718
app-protect=27+3.1088.2-1~[OS_CODENAME]
26622719
```
26632720
2664-
**Note**: Replace the [OS_CODENAME] in the above command with **jammy** for Ubuntu 22.04, and **noble** for Ubuntu 24.04.
2721+
**Note**: Replace the [OS_CODENAME] in the above command with **focal** for Ubuntu 20.04, **jammy** for Ubuntu 22.04, and **noble** for Ubuntu 24.04.
26652722
26662723
## Upgrading App Protect to the latest version
26672724
2668-
### RHEL 8.1+ / RHEL 9+ / Oracle Linux 8.1+ / Rocky Linux 9
2725+
### RHEL 8.1+ / RHEL 9+ / Oracle Linux 8.1+
26692726
26702727
Upgrade the NGINX App Protect WAF to the latest 4.x version:
26712728
26722729
```shell
26732730
sudo dnf -y update app-protect
26742731
```
26752732
2676-
### Debian 11 / Debian 12 / Ubuntu 22.04
2733+
### Debian 11 / Debian 12 / Ubuntu 20.04 / Ubuntu 22.04
26772734
26782735
Upgrade the NGINX App Protect WAF to the latest 4.x version:
26792736

0 commit comments

Comments
 (0)