Skip to content

Commit 14081bd

Browse files
authored
chore: update WAF metadata (#1580)
1 parent 2f622c3 commit 14081bd

Some content is hidden

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

62 files changed

+220
-479
lines changed

content/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: F5 NGINX Product Documentation
33
description: Learn how to deliver, manage, and protect your applications using F5 NGINX products.
44
---
55

6-
# F5 NGINX Product Documentation
7-
Learn how to deliver, manage, and protect your applications using F5 NGINX products.
6+
# F5 NGINX Product Documentation
7+
Learn how to deliver, manage, and protect your applications using F5 NGINX products.
88

99
{{<card-section showAsCards="true" title="F5 NGINX One">}}
1010
{{<card title="F5 NGINX One Console" titleUrl="/nginx-one-console/" brandIcon="NGINX-One-product-icon.svg" isLanding="true">}}

content/waf/_index.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,16 @@
11
---
2-
# The title is the product name
32
title: "F5 WAF for NGINX"
4-
# The URL is the base of the deployed path, becoming "docs.nginx.com/<url>/<other-pages>"
53
url: /waf/
6-
# The cascade directive applies its nested parameters down the page tree until overwritten
74
cascade:
8-
# The logo file is resolved from the theme, in the folder /static/images/icons/
95
logo: NGINX-App-Protect-WAF-product-icon.svg
10-
# The subtitle displays directly underneath the heading of a given page
116
nd-banner:
127
enabled: true
138
start-date: 2025-08-30
149
md: /_banners/waf-unification-notice.md
1510
nd-subtitle: A lightweight, high-performance web application firewall for protecting APIs and applications
16-
# Indicates that this is a custom landing page
1711
nd-landing-page: true
18-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
1912
nd-content-type: landing-page
20-
# Intended for internal catalogue and search, case sensitive:
21-
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
22-
nd-product: NAP-WAF
13+
nd-product: F5WAFN
2314
---
2415

2516
## About

content/waf/changelog/2023.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
---
22
title: "2023 archive"
3-
# Weights are assigned in increments of 100: determines sorting order
43
weight: 200
5-
# Creates a table of contents and sidebar, useful for large documents
64
toc: true
7-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
85
nd-content-type: reference
9-
# Intended for internal catalogue and search, case sensitive:
106
nd-product: F5WAFN
117
---
128

@@ -151,7 +147,7 @@ This release includes new signatures for Anti Automation (bot defense):
151147

152148
### **Important Notes**
153149

154-
- Starting with this release, the `app_protect_compressed_requests_action` directive has been deprecated from the nginx configuration. Now by default the enforcer will decompress all the HTTP compressed payload request and will apply the enforcement.
150+
- Starting with this release, the `app_protect_compressed_requests_action` directive has been deprecated from the nginx configuration. Now by default the enforcer will decompress all the HTTP compressed payload request and will apply the enforcement.
155151

156152
- The F5 NGINX App Protect WAF has been enhanced to include response signature checks within the "filetypes" section. You have an option to enable the signature verification in the response by setting the `responseCheck` parameter to true. By default, this parameter is set to false. See [Restrict Response Signatures]({{< ref "/waf/policies/response-signatures.md" >}}) for more details.
157153

content/waf/changelog/2024.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
---
22
title: "2024 archive"
3-
# Weights are assigned in increments of 100: determines sorting order
43
weight: 100
5-
# Creates a table of contents and sidebar, useful for large documents
64
toc: true
7-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
85
nd-content-type: reference
9-
# Intended for internal catalogue and search, case sensitive:
10-
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
116
nd-product: F5WAFN
127
---
138

content/waf/changelog/_index.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
---
2-
# We use sentence case and present imperative tone
32
title: "Changelog"
43
url: /waf/changelog/
5-
# Weights are assigned in increments of 100: determines sorting order
64
weight: 600
7-
# Creates a table of contents and sidebar, useful for large documents
85
nd-landing-page: true
9-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
106
nd-content-type: reference
11-
# Intended for internal catalogue and search, case sensitive:
127
nd-product: F5WAFN
138
---
149

content/waf/configure/apreload.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
11
---
2-
# We use sentence case and present imperative tone
32
title: "Apply security policy updates without reloading NGINX using apreload"
4-
# Weights are assigned in increments of 100: determines sorting order
53
weight: 100
6-
# Creates a table of contents and sidebar, useful for large documents
74
toc: true
8-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
95
nd-content-type: how-to
10-
# Intended for internal catalogue and search, case sensitive:
11-
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12-
nd-product: NAP-WAF
6+
nd-product: F5WAFN
137
---
148

159
This document describes how to use `apreload`, a tool for updating F5 WAF for NGINX configuration without reloading NGINX.
@@ -61,7 +55,7 @@ When calling _apreload_ directly, it is possible to run it while the previous ex
6155

6256
The new execution will will apply a new configuration, and the most recent configuration will only apply during during the execution period.
6357

64-
In a scenario where an execution from an NGINX reload is followed by a direct _ap_reload_ call, the NGINX workers with the new NGINX configuration will be loaded as soon as the Enforcer finishes processing the existing configuration.
58+
In a scenario where an execution from an NGINX reload is followed by a direct _ap_reload_ call, the NGINX workers with the new NGINX configuration will be loaded as soon as the Enforcer finishes processing the existing configuration.
6559

6660
Once complete, the most recent F5 WAF for NGINX configuration will be loaded using with the same NGINX worker instances.
6761

@@ -77,10 +71,10 @@ If you want to apply either of the two, reload NGINX instead of using _apreload_
7771

7872
## apreload events
7973

80-
_apreload_ events use the same format as operation log events written in the NGINX error log, reporting `configuration_load_success` or `configuration_load_failure` with JSON formatted details.
74+
_apreload_ events use the same format as operation log events written in the NGINX error log, reporting `configuration_load_success` or `configuration_load_failure` with JSON formatted details.
8175

82-
If any of the configuration files are invalid, _apreload_ will discover that and return the proper error message in the `configuration_load_failure event`.
76+
If any of the configuration files are invalid, _apreload_ will discover that and return the proper error message in the `configuration_load_failure event`.
8377

84-
The enforcer will continue to run with the previous working configuration.
78+
The enforcer will continue to run with the previous working configuration.
8579

8680
For more information, see the [Operation logs]({{< ref "/waf/logging/operation-logs.md">}}) topic.

content/waf/configure/compiler.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
---
2-
# We use sentence case and present imperative tone
32
title: "Build and use the compiler tool"
4-
# Weights are assigned in increments of 100: determines sorting order
53
weight: 200
6-
# Creates a table of contents and sidebar, useful for large documents
74
toc: true
8-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
95
nd-content-type: how-to
106
nd-product: F5WAFN
117
---
128

139
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.
1410

15-
You can use it to get the latest security updates for [Attack signatures]({{< ref "/waf/policies/attack-signatures.md" >}}), Threat campaigns and Bot signatures.
11+
You can use it to get the latest security updates for [Attack signatures]({{< ref "/waf/policies/attack-signatures.md" >}}), Threat campaigns and Bot signatures.
1612

1713
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.
1814

@@ -106,7 +102,7 @@ You can can upgrade or downgrade one of the Signatures by specifying a specific
106102

107103
You can use the Docker registry API to list the available image tags.
108104

109-
Replace `<path-to-your-nginx-repo.key>` with the location of your client key and `<path-to-your-nginx-repo.crt>` with the location of your client certificate.
105+
Replace `<path-to-your-nginx-repo.key>` with the location of your client key and `<path-to-your-nginx-repo.crt>` with the location of your client certificate.
110106

111107
```shell
112108
curl -s https://private-registry.nginx.com/v2/nap/waf-compiler/tags/list --key <path-to-your-nginx-repo.key> --cert <path-to-your-nginx-repo.crt>
@@ -150,7 +146,7 @@ Ensure that the output directory is writable, otherwise you may encounter a perm
150146

151147
{{< /call-out >}}
152148

153-
To use multiple policy bundles within a single NGINX configuration, you must supply a [global settings](#global-settings) JSON file.
149+
To use multiple policy bundles within a single NGINX configuration, you must supply a [global settings](#global-settings) JSON file.
154150

155151
This ensures that all bundles have a common foundation such as cookie seed and user-defined signatures.
156152

@@ -184,7 +180,7 @@ docker run --rm \
184180
-include-source -full-export -g $(pwd)/global_settings.json -p $(pwd)/policy.json -o $(pwd)/compiled_policy.tgz
185181
```
186182

187-
This will transform any configuration that relies on external references into an inline configuration within the bundled source.
183+
This will transform any configuration that relies on external references into an inline configuration within the bundled source.
188184

189185
Additionally, when `-include-source` is combined with `-full-export`, the policy.json within the bundle will contain the entire source policy, including any default settings from the base template.
190186

content/waf/configure/converters.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
11
---
2-
# We use sentence case and present imperative tone
32
title: "Build and use the converter tools"
4-
# Weights are assigned in increments of 100: determines sorting order
53
weight: 300
6-
# Creates a table of contents and sidebar, useful for large documents
74
toc: true
8-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
95
nd-content-type: how-to
10-
# Intended for internal catalogue and search, case sensitive:
11-
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12-
nd-product: NAP-WAF
6+
nd-product: F5WAFN
137
---
148

15-
This document describes the tools F5 WAF for NGINX has to convert existing resources or configuration files from a BIG-IP environment for use with F5 WAF for NGINX.
9+
This document describes the tools F5 WAF for NGINX has to convert existing resources or configuration files from a BIG-IP environment for use with F5 WAF for NGINX.
1610

1711
{{< call-out "important" >}}
1812

@@ -158,10 +152,10 @@ docker run -it --rm \
158152
waf-compiler-<version-tag>:custom \
159153
-i /tmp/convert/policy.xml \
160154
-o /tmp/convert/policy.json \
161-
--full-export
155+
--full-export
162156
```
163157

164-
### Keep full configuration (retain elements that may be invalid or irrelevant):
158+
### Keep full configuration (retain elements that may be invalid or irrelevant)
165159
```shell
166160
docker run -it --rm \
167161
-v "$(pwd)":/tmp/convert \

content/waf/configure/kubernetes-read-only.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
11
---
2-
# We use sentence case and present imperative tone
32
title: "Add a read-only filesystem for Kubernetes "
4-
# Weights are assigned in increments of 100: determines sorting order
53
weight: 600
6-
# Creates a table of contents and sidebar, useful for large documents
74
toc: true
8-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
95
nd-content-type: how-to
10-
# Intended for internal catalogue and search, case sensitive:
11-
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12-
nd-product: NAP-WAF
6+
nd-product: F5WAFN
137
---
148

159
This page describes how to add a read-only filesystem when deploying F5 WAF for NGINX when using Kubernetes.

content/waf/configure/nginx-features.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
11
---
2-
# We use sentence case and present imperative tone
32
title: "Configure NGINX features with F5 WAF"
4-
# Weights are assigned in increments of 100: determines sorting order
53
weight: 700
6-
# Creates a table of contents and sidebar, useful for large documents
74
toc: true
8-
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
95
nd-content-type: reference
10-
# Intended for internal catalogue and search, case sensitive:
11-
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12-
nd-product: NAP-WAF
6+
nd-product: F5WAFN
137
---
14-
This document shows examples of how to modify your NGINX configuration to enable F5 WAF for NGINX features.
8+
This document shows examples of how to modify your NGINX configuration to enable F5 WAF for NGINX features.
159

16-
It is intended as a reference for small, self-contained examples of how F5 WAF for NGINX can be configured.
10+
It is intended as a reference for small, self-contained examples of how F5 WAF for NGINX can be configured.
1711

1812
Important constraints when F5 WAF for NGINX is enabled:
1913

@@ -24,7 +18,7 @@ For additional information on configuring NGINX, you should view the [NGINX docu
2418

2519
## Subrequest-based modules
2620

27-
F5 WAF for NGINX inspects direct client-facing requests, but does not inspect internal subrequests generated by subrequest-based modules.
21+
F5 WAF for NGINX inspects direct client-facing requests, but does not inspect internal subrequests generated by subrequest-based modules.
2822

2923
Examples of subrequest-based modules:
3024

0 commit comments

Comments
 (0)