You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For a virtual machine or bare metal installation, only NGINX Plus is available.
4
+
5
+
If you would like to use NGINX Open Source, you should follow [Docker]({{< ref "/waf/install/docker.md" >}}) or [Kubernetes]({{< ref "/waf/install/kubernetes.md" >}}) instructions.
Copy file name to clipboardExpand all lines: content/controller/admin-guides/install/install-for-controller.md
+26-26Lines changed: 26 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
---
2
-
description: Take the steps in this guide to deploy F5 NGINX App Protect WAF as a
2
+
description: Take the steps in this guide to deploy F5 WAF for NGINX as a
3
3
datapath instance for use with NGINX Controller.
4
4
nd-docs: DOCS-645
5
-
title: Using NGINX App Protect WAF with NGINX Controller
5
+
title: Using F5 WAF for NGINX with NGINX Controller
6
6
toc: true
7
7
weight: 500
8
8
type:
@@ -13,12 +13,12 @@ type:
13
13
14
14
## Setup
15
15
16
-
Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/admin-guide/install#prerequisites" >}}), [Platform Security Considerations]({{< ref "/nap-waf/v4/admin-guide/install#platform-security-considerations" >}}) and [User Permissions]({{< ref "/nap-waf/v4/admin-guide/install#user-permissions" >}}) sections of the NGINX App Protect WAF Admin Guide.
16
+
Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/admin-guide/install#prerequisites" >}}), [Platform Security Considerations]({{< ref "/nap-waf/v4/admin-guide/install#platform-security-considerations" >}}) and [User Permissions]({{< ref "/nap-waf/v4/admin-guide/install#user-permissions" >}}) sections of the F5 WAF for NGINX Admin Guide.
17
17
18
18
19
-
## Install NGINX App Protect WAF
19
+
## Install F5 WAF for NGINX
20
20
21
-
**Note:** If a version of NGINX App Protect WAF prior to 3.6 is required, please contact the NGINX Sales team to assist with this configuration.
21
+
**Note:** If a version of F5 WAF for NGINX prior to 3.6 is required, please contact the NGINX Sales team to assist with this configuration.
22
22
23
23
{{<tabsname="install-nap-waf">}}
24
24
@@ -66,19 +66,19 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
9. If NGINX Plus or NGINX App Protect WAF was previously installed on the system, clean up package manager cache information:
75
+
9. If NGINX Plus or F5 WAF for NGINX was previously installed on the system, clean up package manager cache information:
76
76
77
77
```shell
78
78
sudo yum clean all
79
79
```
80
80
81
-
10. Install the latest NGINX App Protect WAF package.
81
+
10. Install the latest F5 WAF for NGINX package.
82
82
83
83
**See Also:** Please refer to [NGINX App Protect Compatibility Matrix]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#nginx-app-protect-compatibility-matrix" >}}) for specific version compatibility.
84
84
@@ -94,7 +94,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
94
94
sudo nginx -v
95
95
```
96
96
97
-
12. Configure SELinux as appropriate per your organization’s security policies. NGINX App Protect WAF applies the prebuilt SELinux policy module during the installation. If you encounter any issues, check the [Troubleshooting Guide]({{< ref "/nap-waf/v4/troubleshooting-guide/troubleshooting#selinux">}}).
97
+
12. Configure SELinux as appropriate per your organization’s security policies. F5 WAF for NGINX applies the prebuilt SELinux policy module during the installation. If you encounter any issues, check the [Troubleshooting Guide]({{< ref "/nap-waf/v4/troubleshooting-guide/troubleshooting#selinux">}}).
98
98
99
99
**Note:** NGINX Controller has specific [requirements regarding SELinux configuration]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#supported-distributions">}}).
100
100
@@ -171,7 +171,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
10. If NGINX Plus or NGINX App Protect WAF was previously installed on the system, clean up package manager cache information:
207
+
10. If NGINX Plus or F5 WAF for NGINX was previously installed on the system, clean up package manager cache information:
208
208
209
209
```shell
210
210
sudo yum clean all
211
211
```
212
212
213
-
11. Install the latest NGINX App Protect WAF package.
213
+
11. Install the latest F5 WAF for NGINX package.
214
214
215
215
**See Also:** Please refer to [NGINX App Protect Compatibility Matrix]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#nginx-app-protect-compatibility-matrix" >}}) for specific version compatibility.
216
216
@@ -226,7 +226,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
226
226
sudo nginx -v
227
227
```
228
228
229
-
13. Configure SELinux as appropriate per your organization’s security policies. NGINX App Protect WAF applies the prebuilt SELinux policy module during the installation. If you encounter any issues, check the [Troubleshooting Guide]({{< ref "/nap-waf/v4/troubleshooting-guide/troubleshooting#selinux" >}}).
229
+
13. Configure SELinux as appropriate per your organization’s security policies. F5 WAF for NGINX applies the prebuilt SELinux policy module during the installation. If you encounter any issues, check the [Troubleshooting Guide]({{< ref "/nap-waf/v4/troubleshooting-guide/troubleshooting#selinux" >}}).
230
230
231
231
**Note:** NGINX Controller has specific [requirements regarding SELinux configuration]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#supported-distributions" >}}).
232
232
@@ -263,7 +263,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
263
263
264
264
{{%tab name="Debian"%}}
265
265
266
-
**Note:** As of NGINX Plus R24, support for Debian 9 is no longer available. As a consequence, NGINX App Protect WAF 3.1 is the final version available for this operating system version.
266
+
**Note:** As of NGINX Plus R24, support for Debian 9 is no longer available. As a consequence, F5 WAF for NGINX 3.1 is the final version available for this operating system version.
267
267
268
268
1. If you already have NGINX packages in your system, back up your configs and logs:
269
269
@@ -312,7 +312,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
312
312
printf "deb https://pkgs.nginx.com/plus/debian `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nginx-plus.list
313
313
```
314
314
315
-
9. Add NGINX App Protect WAF repository:
315
+
9. Add F5 WAF for NGINX repository:
316
316
317
317
```shell
318
318
printf "deb https://pkgs.nginx.com/app-protect/debian `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nginx-app-protect.list
@@ -324,7 +324,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
11. Update the repository and install the lastest supported NGINX App Protect WAF packages.
327
+
11. Update the repository and install the lastest supported F5 WAF for NGINX packages.
328
328
329
329
**See Also:** Please refer to [NGINX App Protect Compatibility Matrix]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#nginx-app-protect-compatibility-matrix" >}}) for specific version compatibility.
330
330
@@ -430,7 +430,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
430
430
printf "deb https://pkgs.nginx.com/plus/ubuntu `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nginx-plus.list
431
431
```
432
432
433
-
9. Add NGINX App Protect WAF repository:
433
+
9. Add F5 WAF for NGINX repository:
434
434
435
435
```shell
436
436
printf "deb https://pkgs.nginx.com/app-protect/ubuntu `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nginx-app-protect.list
@@ -442,7 +442,7 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
11. Update the repository and install the latest App Protect WAF package.
445
+
11. Update the repository and install the latest F5 WAF for NGINX package.
446
446
447
447
**See Also:** Please refer to [NGINX App Protect Compatibility Matrix]({{< ref "/controller/admin-guides/install/nginx-controller-tech-specs.md#nginx-app-protect-compatibility-matrix" >}}) for specific version compatibility.
448
448
@@ -497,34 +497,34 @@ Before proceeding, you should review the [Prerequisites]({{< ref "/nap-waf/v4/ad
497
497
498
498
16. To upgrade your signature package to the latest version and obtain the best protection, refer to [Updating App Protect Attack Signatures]({{< ref "/nap-waf/v4/admin-guide/install#ubuntu-1804" >}}).
499
499
500
-
**Note:** Ubuntu 20.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.
500
+
**Note:** Ubuntu 20.04 activates **AppArmor** by default, but F5 WAF for NGINX will run in unconfined mode after being installed as it is shipped with no AppArmor profile. To benefit from AppArmor access control capabilities for F5 WAF for NGINX, you will have to write your own AppArmor profile for F5 WAF for NGINX executables found in `/opt/app_protect/bin` such that it best suits your environment.
501
501
502
502
{{%/tab%}}
503
503
504
504
{{%tab name="Amazon Linux 2 LTS"%}}
505
505
506
-
Using NGINX App Protect WAF with NGINX Controller isn't supported on Amazon Linux 2 LTS.
506
+
Using F5 WAF for NGINX with NGINX Controller isn't supported on Amazon Linux 2 LTS.
507
507
508
508
{{%/tab%}}
509
509
510
510
{{%tab name="Alpine"%}}
511
511
512
-
Using NGINX App Protect WAF with NGINX Controller isn't supported on Alpine.
512
+
Using F5 WAF for NGINX with NGINX Controller isn't supported on Alpine.
513
513
514
514
{{%/tab%}}
515
515
{{</tabs>}}
516
516
517
517
<hr>
518
518
519
-
## Add NGINX App Protect WAF to NGINX Controller
519
+
## Add F5 WAF for NGINX to NGINX Controller
520
520
521
-
If this NGINX Plus instance is already managed by Controller, [restart the Agent]({{< ref "/controller/admin-guides/install/agent-restart" >}}) after NGINX App Protect WAF is installed.
521
+
If this NGINX Plus instance is already managed by Controller, [restart the Agent]({{< ref "/controller/admin-guides/install/agent-restart" >}}) after F5 WAF for NGINX is installed.
522
522
523
-
Otherwise, complete the tasks in the NGINX Controller [Add an NGINX App Protect WAF Instance]({{< ref "/controller/infrastructure/instances/add-nap-instance.md#add-the-nginx-app-protect-instance" >}}) guide.
523
+
Otherwise, complete the tasks in the NGINX Controller [Add an F5 WAF for NGINX Instance]({{< ref "/controller/infrastructure/instances/add-nap-instance.md#add-the-nginx-app-protect-instance" >}}) guide.
524
524
525
-
## Use NGINX App Protect WAF with NGINX Controller
525
+
## Use F5 WAF for NGINX with NGINX Controller
526
526
527
-
**Note:** When configuring NGINX App Protect WAF as a datapath instance for NGINX Controller, **you should not modify the `nginx.conf` file**. The `nginx.conf` file will be automatically updated when enabling WAF on a Component in NGINX Controller.
527
+
**Note:** When configuring F5 WAF for NGINX as a datapath instance for NGINX Controller, **you should not modify the `nginx.conf` file**. The `nginx.conf` file will be automatically updated when enabling WAF on a Component in NGINX Controller.
528
528
529
529
Refer to the following NGINX Controller user guides for further information about how to secure your apps and/or APIs with NGINX Controller:
Copy file name to clipboardExpand all lines: content/controller/app-delivery/about-snippets.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -557,7 +557,7 @@ The `reuseport` parameter creates an individual listening socket for each worker
557
557
558
558
## Extend App Security with Snippets
559
559
560
-
When adding [NGINX Controller App Security]({{< ref "add-app-security-with-waf" >}}) to your components, you can use Snippets to add NGINX App Protect directives that aren't represented in the NGINX Controller API. You can also use Snippets to [tune your NGINX App Protect WAF performance]({{< ref "/controller/app-delivery/security/tutorials/tune-waf-for-app" >}}).
560
+
When adding [NGINX Controller App Security]({{< ref "add-app-security-with-waf" >}}) to your components, you can use Snippets to add NGINX App Protect directives that aren't represented in the NGINX Controller API. You can also use Snippets to [tune your F5 WAF for NGINX performance]({{< ref "/controller/app-delivery/security/tutorials/tune-waf-for-app" >}}).
561
561
562
562
Refer to [Extend App Security with Snippets]({{< ref "extend-app-security-snippets" >}}) for more information and examples.
Copy file name to clipboardExpand all lines: content/controller/app-delivery/security/concepts/bring-your-own-policy.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
description: Learn how to use your own F5 NGINX App Protect WAF policies with NGINX
2
+
description: Learn how to use your own F5 WAF for NGINX policies with NGINX
3
3
Controller.
4
4
nd-docs: DOCS-481
5
5
title: Bring Your Own WAF Policy
@@ -17,35 +17,35 @@ A BYO NGINX App Protect policy lets you maintain consistent Security Policies ac
17
17
18
18
To export a policy from F5 Advanced WAF or ASM, take the following steps:
19
19
20
-
1. Convert your F5 XML security policy to an NGINX App Protect WAF declarative JSON policy using the [NGINX App Protect Policy Converter tool](https://docs.nginx.com/nginx-app-protect/configuration/#policy-converter).
20
+
1. Convert your F5 XML security policy to an F5 WAF for NGINX declarative JSON policy using the [NGINX App Protect Policy Converter tool](https://docs.nginx.com/nginx-app-protect/configuration/#policy-converter).
21
21
{{< call-out "note" >}}We recommend using the Converter tool that corresponds with the most recent NGINX App Protect version.{{< /call-out >}}
22
22
23
23
2. Use the NGINX App Protect declarative JSON policy as the WAF policy in NGINX Controller for your app component(s).
24
24
25
25
26
26
27
-
With a BYO NGINX App Protect policy, you can also provide customized security by crafting an NGINX App Protect WAF policy that specifies the security controls appropriate for your apps. For more information on how to configure an NGINX App Protect WAF policy, refer to the [NGINX App Protect Configuration Guide](https://docs.nginx.com/nginx-app-protect/configuration/).
27
+
With a BYO NGINX App Protect policy, you can also provide customized security by crafting an F5 WAF for NGINX policy that specifies the security controls appropriate for your apps. For more information on how to configure an F5 WAF for NGINX policy, refer to the [NGINX App Protect Configuration Guide](https://docs.nginx.com/nginx-app-protect/configuration/).
28
28
29
29
## Security Strategy for BYO NGINX App Protect Policy
30
30
31
31
The BYO NGINX App Protect policy uses the concept of a [Security Strategy]({{< ref "/controller/app-delivery/security/concepts/what-is-waf.md#security-policy-and-security-strategy" >}})
32
32
33
33
With the BYO NGINX App Protect policy feature, you can specify the exact NGINX App Protect policy for the Security Strategy. Then, the Security Strategy can be shared across -- and referenced by -- multiple app components.
34
-
A Security Strategy can be comprised of various app-security-related Security Policies. NGINX Controller includes a custom NGINX App Protect WAF policy, which can be assigned to a Security Strategy.
34
+
A Security Strategy can be comprised of various app-security-related Security Policies. NGINX Controller includes a custom F5 WAF for NGINX policy, which can be assigned to a Security Strategy.
35
35
36
-
You can also add a BYO NGINX App Protect WAF policy in JSON format to NGINX Controller "as-is" for use in a Security Strategy.
36
+
You can also add a BYO F5 WAF for NGINX policy in JSON format to NGINX Controller "as-is" for use in a Security Strategy.
37
37
38
38
39
-
An **App Component** contains a reference to a **Security Strategy**, which, in turn, references a Security Policy. This Security Policy contains the **NGINX App Protect WAF policy**.
39
+
An **App Component** contains a reference to a **Security Strategy**, which, in turn, references a Security Policy. This Security Policy contains the **F5 WAF for NGINX policy**.
40
40
41
41
Refer to the topic [Enable WAF for a Component Using Your Own NGINX App Protect Policy]({{< ref "/controller/app-delivery/security/tutorials/add-app-security-with-waf.md#enable-waf-for-a-component-using-your-own-nap-policy-beta" >}}) to get started.
42
42
43
43
## Limitations
44
44
45
45
BYO NAP WAF policy currently has the following limitations:
46
46
47
-
- The size of the BYO NGINX App Protect WAF policy that's referenced by app components may affect application performance.
48
-
- References to external files, such as the following, in the NGINX App Protect WAF JSON declarative policy are not supported:
47
+
- The size of the BYO F5 WAF for NGINX policy that's referenced by app components may affect application performance.
48
+
- References to external files, such as the following, in the F5 WAF for NGINX JSON declarative policy are not supported:
0 commit comments