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
Copy file name to clipboardExpand all lines: content/waf/configure/compiler.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,10 +14,16 @@ nd-product: NAP-WAF
14
14
15
15
This document describes how to use the F5 WAF for NGINX compiler, a tool for converting security policies and logging profiles from JSON to a bundle file that F5 WAF can process and apply.
16
16
17
-
You can use it to get the latest security updates for Attack Signatures, Threat Campaigns and Bot Signatures. The compiler is packaged as a Docker image and can executed using the Docker CLI or as part of a continuous integration/continuous delivery (CI/CD) pipeline.
17
+
You can use it to get the latest security updates for [Attack signatures]({{< ref "/waf/policies/attack-signatures.md" >}}), Threat campaigns and Bot signatures.
18
+
19
+
The compiler is packaged as a Docker image and can executed using the Docker CLI or as part of a continuous integration/continuous delivery (CI/CD) pipeline.
20
+
21
+
With a virtual machine/bare-metal installation, read the [Update F5 WAF for NGINX signatures]({{< ref "/waf/install/update-signatures.md" >}}) topic.
18
22
19
23
One or more bundle files can be referenced in the NGINX configuration file, and you can configure global settings such as the cookie seed and user-defined signatures.
20
24
25
+
For more information about policies, read the [Configure policies]({{< ref "/waf/policies/configuration.md" >}}) topic.
26
+
21
27
## Before you begin
22
28
23
29
To complete this guide, you will need the following prerequisites:
Copy file name to clipboardExpand all lines: content/waf/configure/nginx-features.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
@@ -16,7 +16,7 @@ This document shows example of how to modify your NGINX configuration to enable
16
16
17
17
It is intended as a reference for, small self-contained examples of how F5 WAF for NGINX is configured.
18
18
19
-
Certain features do not work well with F5 NGINX, such as modules requiring _subrequest_ when calling or being called from a scope that contains `app_protect_enable on`.
19
+
Certain features do not work well with NGINX, such as modules requiring _subrequest_ when calling or being called from a scope that contains `app_protect_enable on`.
20
20
21
21
Modules requiring the _Range_ header (Such as _Slice_) are also unsupported in a scope which enables F5 WAF for NGINX.
The term _disconnected environment_ has become the more commmon synonym for an air-gapped or offline installation. It follows the precedent set by NGINX Instance Manager: [Deploy in a disconnected environment -> Install the latest NGINX Instance Manager with a script (disconnected)]({{< ref "/nim/disconnected/offline-install-guide.md" >}}).
18
-
19
17
The design intention for this page is as a standalone page for the operating system specific installation use cases:
Instead of having separate top level folders, differences between v4 and v5 will be denoted with whole page sections, tabs, or other unique signifiers.
22
+
{{</ call-out>}}
23
+
24
+
This topic describes how to install F5 WAF for NGINX in a disconnected or air-gapped environment.
25
+
26
+
Many of the steps involved are similar to other installation methods: this document will refer to them when appropriate.
27
+
28
+
## Before you begin
29
+
30
+
To complete this guide, you will need the following prerequisites:
31
+
32
+
- The requirements of your installation method:
33
+
-[Virtual machine or bare metal]({{< ref "/waf/install/virtual-environment.md#before-you-begin" >}})
- An active F5 WAF for NGINX subscription (Purchased or trial).
37
+
- A connected environment with similar architecture
38
+
- A method to transfer files between two environments
39
+
40
+
These instructions outline the broad, conceptual steps involved with working with a disconnected environment. You will need to make adjustments based on your specific security requirements.
41
+
42
+
Some users may be able to use a USB stick to transfer necessary set-up artefacts, whereas other users may be able to use tools such as SSH or SCP.
43
+
44
+
In the following sections, the term _connected environment_ refers to the environment with access to the internet you will use to download set-up artefacts.
45
+
46
+
The term _disconnected environment_ refers to the final environment the F5 WAF for NGINX installation is intended to run in, and is the target to transfer set-up artefacts from the connected environment.
47
+
48
+
## Download and run the documentation website locally
49
+
50
+
For a disconnected environment, you may want to browse documentation offline.
51
+
52
+
This is possible by cloning the repository and the binary file for Hugo.
53
+
54
+
In addition to accessing F5 WAF for NGINX documentation, you will be able to access any supporting documentation you may need from other products.
55
+
56
+
You will need `git` and `wget` in your connected environment.
57
+
58
+
Run the following two commands: replace `<hugo-release>` with the tarball appropriate to the environment from [the release page](https://github.com/gohugoio/hugo/releases/tag/v0.147.8):
The `<JWT Token>` argument should be the _contents_ of the file, not the file itself. Ensure there are no additional characters such as extra whitespace.
375
375
376
-
377
-
### Edit Manifest files
376
+
### Create Manifest files
378
377
379
378
The default configuration provided creates two replicas, each hosting NGINX and WAF services together in a single Kubernetes pod.
380
379
381
380
Create all of these files in a single folder (Such as `/manifests`).
382
381
383
382
In each file, replace `<your-private-registry>/waf:<your-tag>` with your actual image tag.
This topic describes how to update F5 WAF for NGINX signatures in a [virtual machine or bare-metal environment]({{< ref "/waf/install/virtual-environment.md" >}}).
16
+
17
+
For other deployment methods, you should read [Build and use the compiler tool]({{< ref "/waf/configure/compiler.md" >}}).
F5 WAF for NGINX signature updates are released at a higher frequency than F5 WAF for NGINX itself, and are subsequently available in their own packages.
26
+
27
+
A new installation will have the latest signatures available, but F5 WAF for NGINX and the signature packages can be updated independently afterwards.
28
+
29
+
## Identify and update packages
30
+
31
+
During installation, the [Platform-specific instructions]({{< ref "/waf/install/virtual-environment.md#platform-specific-instructions" >}}) were used to add the F5 WAF for NGINX repositories to your chosen operating system.
32
+
33
+
Installing these packages also installed their dependencies, which includes the signature packages. You can use your environment's package manager to update these packages.
34
+
35
+
They will be named something in the following list:
This document describes how to upgrade F5 WAF for NGINX.
25
+
26
+
Security updates can be managed independently from F5 WAF for NGINX versions: based on your installation method, you should read the [Update F5 WAF for NGINX signatures]({{< ref "/waf/install/update-signatures.md" >}}) or [Build and use the compiler tool]({{< ref "/waf/configure/compiler.md" >}}) topics.
27
+
28
+
## Virtual environment packages
29
+
30
+
Depending on your method, you may have installed virtual environment packages as part of a virtual machine/bare metal installation or a hybrid Docker configuration deployment.
31
+
32
+
You can update the F5 WAF for NGINX packages using the environment's package manager, used during the [Platform-specific instructions]({{< ref "/waf/install/virtual-environment.md#platform-specific-instructions" >}}) of installation.
33
+
34
+
An operating system using `dnf` might update the package with this command:
35
+
36
+
```shell
37
+
sudo dnf -y update app-protect
38
+
```
39
+
40
+
While an `apt` based system would use the following instead:
You can upgrade packages within Docker containers the same way as in the [Virtual environment packages](#virtual-environment-packages) section.
49
+
50
+
Otherwise, you can update the version of F5 WAF components you are using by changing the tag prefixed to the `image:` key in your _docker-compose_ files.
51
+
52
+
## Kubernetes deployments
53
+
54
+
In a Kubernetes deployment, your approach for upgrading F5 WAF for NGINX depends on your installation method.
0 commit comments