Skip to content

Commit 2a6e157

Browse files
ADubhlaoichADubhlaoich
committed
feat: Add Alpine 1.19 support to NGINX App Protect WAF documentation
As part of the NGINX App Protect WAF 5.5 release, Alpine 1.19 support has been added. This commit updates the relevant sections of documentation that mention Alpine support, while also fixing up the metadata for some related pages.
1 parent b188442 commit 2a6e157

File tree

9 files changed

+131
-50
lines changed

9 files changed

+131
-50
lines changed

‎content/includes/nap-waf/config/v5/build-nginx-image-oss/build-alpine.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
```dockerfile
22
# syntax=docker/dockerfile:1
33

4-
# Supported OS_VER's are 3.16/3.17
5-
ARG OS_VER="3.17"
4+
# Supported OS_VER's are 3.16/3.19
5+
ARG OS_VER="3.19"
66

77
# Base image
88
FROM alpine:${OS_VER}

‎content/includes/nap-waf/config/v5/build-nginx-image-plus/build-alpine.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
```dockerfile
22
# syntax=docker/dockerfile:1
33

4-
# Supported OS_VER's are 3.16/3.17
5-
ARG OS_VER="3.17"
4+
# Supported OS_VER's are 3.16/3.17/3.19
5+
ARG OS_VER="3.19"
66

77
# Base image
88
FROM alpine:${OS_VER}

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

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
description: This guide explains how to deploy F5 NGINX App Protect WAF v4 as well as
3-
upgrade App Protect and the App Protect signature sets.
4-
docs: DOCS-646
5-
doctypes:
6-
- task
72
title: NGINX App Protect WAF Administration Guide
8-
toc: true
93
weight: 100
4+
toc: true
5+
type: how-to
6+
product: NAP-WAF
7+
docs: DOCS-646
8+
109
---
1110

1211
## Overview
@@ -41,23 +40,24 @@ NGINX App Protect WAF supports the following operating systems:
4140
- [Ubuntu 20.04 (Focal)](#ubuntu-1804--ubuntu-2004--ubuntu-2204--ubuntu-2404-installation)
4241
- [Ubuntu 22.04 (Jammy)](#ubuntu-1804--ubuntu-2004--ubuntu-2204--ubuntu-2404-installation)
4342
- [Ubuntu 24.04 (Noble)](#ubuntu-1804--ubuntu-2004--ubuntu-2204--ubuntu-2404-installation)
44-
- [Alpine 3.16](#alpine-316--alpine-317-installation) - (Deprecated starting from NGINX Plus R33)
45-
- [Alpine 3.17](#alpine-316--alpine-317-installation)
43+
- [Alpine 3.16](#alpine-316-317--319-installation) - (Deprecated starting from NGINX Plus R33)
44+
- [Alpine 3.17](#alpine-316-317--319-installation)
45+
- [Alpine 3.19](#alpine-316-317--319-installation)
4646

4747

4848
The NGINX App Protect WAF package has the following dependencies:
4949

5050
1. **nginx-plus-module-appprotect** - NGINX Plus dynamic module for App Protect
51-
2. **app-protect-engine** - The App Protect enforcement engine
52-
3. **app-protect-plugin** - The App Protect connector API between the engine and the NGINX Plus dynamic module
53-
4. **app-protect-compiler** - The App Protect enforcement engine compiler agent
54-
5. **app-protect-common** - The App Protect shared libraries package
55-
6. **app-protect-geoip** - The App Protect geolocation update package
56-
6. **app-protect-graphql** - The App Protect shared library package for GraphQL protection
57-
7. **app-protect-attack-signatures** - The App Protect attack signatures update package
58-
8. **app-protect-threat-campaigns** - The App Protect threat campaigns update package
59-
9. **app-protect-bot-signatures** - The App Protect bot signatures update package
60-
9. **app-protect-selinux** - The prebuilt SELinux policy module for NGINX App Protect WAF (optional dependency)
51+
1. **app-protect-engine** - The App Protect enforcement engine
52+
1. **app-protect-plugin** - The App Protect connector API between the engine and the NGINX Plus dynamic module
53+
1. **app-protect-compiler** - The App Protect enforcement engine compiler agent
54+
1. **app-protect-common** - The App Protect shared libraries package
55+
1. **app-protect-geoip** - The App Protect geolocation update package
56+
1. **app-protect-graphql** - The App Protect shared library package for GraphQL protection
57+
1. **app-protect-attack-signatures** - The App Protect attack signatures update package
58+
1. **app-protect-threat-campaigns** - The App Protect threat campaigns update package
59+
1. **app-protect-bot-signatures** - The App Protect bot signatures update package
60+
1. **app-protect-selinux** - The prebuilt SELinux policy module for NGINX App Protect WAF (optional dependency)
6161

6262
See the NGINX Plus full list of prerequisites for more details. NGINX App Protect WAF can be installed as a module to an existing NGINX Plus installation or as a complete NGINX Plus with App Protect installation in a clean environment.
6363

@@ -1208,7 +1208,7 @@ If a user other than **nginx** is to be used, note the following:
12081208
{{< /note >}}
12091209
12101210
1211-
## Alpine 3.16 / Alpine 3.17 Installation
1211+
## Alpine 3.16, 3.17 & 3.19 Installation
12121212
12131213
1. If you already have NGINX packages in your system, back up your configs and logs:
12141214

‎content/nap-waf/v5/admin-guide/compiler.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
2-
description: This guide describes the steps to build, use, and update the F5 NGINX App
3-
Protect WAF v5 Compiler.
4-
docs: DOCS-1367
5-
doctypes:
6-
- task
72
title: NGINX App Protect WAF Compiler
8-
toc: true
93
weight: 500
4+
toc: true
5+
type: how-to
6+
product: NAP-WAF
7+
docs: DOCS-1367
108
---
119

1210
## Overview

‎content/nap-waf/v5/admin-guide/deploy-on-docker.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
description: This guide explains how to deploy F5 NGINX App Protect WAF v5 release using Docker Compose.
3-
docs: DOCS-1365
4-
doctypes:
5-
- task
62
title: Deploying NGINX App Protect WAF on Docker
3+
weight: 400
74
toc: true
8-
weight: 300
5+
type: how-to
6+
product: NAP-WAF
7+
docs: DOCS-1365
98
---
109

1110
## Prerequisites

‎content/nap-waf/v5/admin-guide/deploy-on-kubernetes.md‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
---
2-
description: This guide explains how to deploy F5 NGINX App Protect WAF v5 release in
3-
a Kubernetes environment.
4-
docs: DOCS-1366
5-
doctypes:
6-
- task
72
title: Deploying NGINX App Protect WAF on Kubernetes
3+
weight: 300
84
toc: true
9-
weight: 400
5+
type: how-to
6+
product: NAP-WAF
7+
docs: DOCS-1366
108
---
119

1210
## Prerequisites

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

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
title: Installing NGINX App Protect WAF
3+
weight: 200
34
toc: true
5+
type: how-to
6+
product: NAP-WAF
47
docs: DOCS-1363
58
---
69

@@ -43,6 +46,13 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
4346
{{< include "nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-alpine" >}}
4447

4548
{{%/tab%}}
49+
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+
4656
{{%tab name="Amazon Linux 2"%}}
4757

4858
1. Create the `/etc/ssl/nginx` directory:
@@ -138,6 +148,7 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
138148
```
139149

140150
{{%/tab%}}
151+
141152
{{%tab name="Alpine Linux 3.17"%}}
142153

143154
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}
@@ -149,6 +160,19 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
149160
```
150161

151162
{{%/tab%}}
163+
164+
{{%tab name="Alpine Linux 3.19"%}}
165+
166+
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}
167+
168+
3. Install the NGINX App Protect WAF v5 package:
169+
170+
```shell
171+
sudo apk add app-protect-module-oss
172+
```
173+
174+
{{%/tab%}}
175+
152176
{{%tab name="Amazon Linux 2"%}}
153177

154178
1. Create the file named `/etc/yum.repos.d/nginx.repo` with the following contents:
@@ -331,6 +355,19 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
331355
```
332356

333357
{{%/tab%}}
358+
359+
{{%tab name="Alpine Linux 3.19"%}}
360+
361+
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-alpine.md" >}}
362+
363+
3. Install the NGINX App Protect WAF v5 package:
364+
365+
```shell
366+
sudo apk add app-protect-module-plus
367+
```
368+
369+
{{%/tab%}}
370+
334371
{{%tab name="Amazon Linux 2"%}}
335372

336373
1. Download the NGINX Plus repository file [nginx-plus-amazon2.repo](https://cs.nginx.com/static/files/nginx-plus-amazon2.repo) to `/etc/yum.repos.d`:
@@ -697,6 +734,7 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
697734
```
698735
699736
{{%/tab%}}
737+
700738
{{%tab name="Alpine Linux 3.17"%}}
701739
702740
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}
@@ -710,6 +748,21 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
710748
```
711749
712750
{{%/tab%}}
751+
752+
{{%tab name="Alpine Linux 3.19"%}}
753+
754+
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}
755+
756+
3. Download all NGINX Open Source packages, including all dependencies:
757+
758+
```shell
759+
sudo mkdir /etc/packages/
760+
sudo apk update
761+
sudo apk fetch --recursive --output /etc/packages app-protect-module-oss
762+
```
763+
764+
{{%/tab%}}
765+
713766
{{%tab name="Amazon Linux 2"%}}
714767
715768
1. Create the file named `/etc/yum.repos.d/nginx.repo` with the following contents:
@@ -922,6 +975,21 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
922975
```
923976
924977
{{%/tab%}}
978+
979+
{{%tab name="Alpine Linux 3.19"%}}
980+
981+
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-alpine.md" >}}
982+
983+
3. Download all NGINX Plus packages, including all dependencies:
984+
985+
```shell
986+
sudo mkdir /etc/packages/
987+
sudo apk update
988+
sudo apk fetch --recursive --output /etc/packages app-protect-module-plus
989+
```
990+
991+
{{%/tab%}}
992+
925993
{{%tab name="Amazon Linux 2023"%}}
926994
927995
{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-amzn2023.md" >}}
@@ -1295,6 +1363,25 @@ sudo apk del app-protect-module-plus
12951363
```
12961364

12971365
{{%/tab%}}
1366+
1367+
{{%tab name="Alpine Linux 3.19"%}}
1368+
1369+
For NGINX Open Source
1370+
Uninstall the NGINX App Protect WAF v5 package:
1371+
1372+
```shell
1373+
sudo apk del app-protect-module-oss
1374+
```
1375+
1376+
For NGINX Plus
1377+
Uninstall the NGINX App Protect WAF v5 package:
1378+
1379+
```shell
1380+
sudo apk del app-protect-module-plus
1381+
```
1382+
1383+
{{%/tab%}}
1384+
12981385
{{%tab name="Amazon Linux 2"%}}
12991386

13001387
For NGINX Open Source

‎content/nap-waf/v5/admin-guide/overview.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
description: This guide explains how to deploy F5 NGINX App Protect WAF v5.
3-
docs: DOCS-1362
4-
doctypes:
5-
- task
62
title: NGINX App Protect WAF Administration Guide
7-
toc: true
83
weight: 100
4+
toc: true
5+
type: how-to
6+
product: NAP-WAF
7+
docs: DOCS-1362
98
---
109

1110
## Introduction
@@ -35,7 +34,7 @@ NGINX App Protect WAF v5 supports the following operating systems:
3534

3635
| Distribution | Version |
3736
| ------------ | ------------------- |
38-
| Alpine | 3.17 |
37+
| Alpine | 3.17, 3.19 |
3938
| Debian | 11, 12 |
4039
| Ubuntu | 20.04, 22.04, 24.04 |
4140
| Amazon Linux | 2023 |

‎content/nap-waf/v5/admin-guide/upgrade-nap-waf.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "Upgrade NGINX App Protect WAF on Managed Instances"
3-
description: "How to Upgrade F5 NGINX App Protect WAF on managed NGINX instances"
2+
title: Upgrade NGINX App Protect WAF on Managed Instances
43
weight: 600
54
toc: true
6-
tags: [ "NGINX Management Suite" ]
7-
docs: "DOCS-1640"
5+
type: how-to
6+
product: NAP-WAF
7+
docs: DOCS-1640
88
---
99

1010
## Overview

0 commit comments

Comments
 (0)