Skip to content

feat: Add Alpine 1.19 support to NGINX App Protect WAF documentation #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```dockerfile
# syntax=docker/dockerfile:1

# Supported OS_VER's are 3.16/3.17
ARG OS_VER="3.17"
# Supported OS_VER's are 3.16/3.19
ARG OS_VER="3.19"

# Base image
FROM alpine:${OS_VER}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
```dockerfile
# syntax=docker/dockerfile:1

# Supported OS_VER's are 3.16/3.17
ARG OS_VER="3.17"
# Supported OS_VER's are 3.16/3.17/3.19
ARG OS_VER="3.19"

# Base image
FROM alpine:${OS_VER}
Expand Down
38 changes: 19 additions & 19 deletions content/nap-waf/v4/admin-guide/install.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
description: This guide explains how to deploy F5 NGINX App Protect WAF v4 as well as
upgrade App Protect and the App Protect signature sets.
docs: DOCS-646
doctypes:
- task
title: NGINX App Protect WAF Administration Guide
toc: true
weight: 100
toc: true
type: how-to
product: NAP-WAF
docs: DOCS-646

---

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


The NGINX App Protect WAF package has the following dependencies:

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

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.

Expand Down Expand Up @@ -1208,7 +1208,7 @@ If a user other than **nginx** is to be used, note the following:
{{< /note >}}


## Alpine 3.16 / Alpine 3.17 Installation
## Alpine 3.16, 3.17 & 3.19 Installation

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

Expand Down
10 changes: 4 additions & 6 deletions content/nap-waf/v5/admin-guide/compiler.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
description: This guide describes the steps to build, use, and update the F5 NGINX App
Protect WAF v5 Compiler.
docs: DOCS-1367
doctypes:
- task
title: NGINX App Protect WAF Compiler
toc: true
weight: 500
toc: true
type: how-to
product: NAP-WAF
docs: DOCS-1367
---

## Overview
Expand Down
9 changes: 4 additions & 5 deletions content/nap-waf/v5/admin-guide/deploy-on-docker.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
description: This guide explains how to deploy F5 NGINX App Protect WAF v5 release using Docker Compose.
docs: DOCS-1365
doctypes:
- task
title: Deploying NGINX App Protect WAF on Docker
weight: 400
toc: true
weight: 300
type: how-to
product: NAP-WAF
docs: DOCS-1365
---

## Prerequisites
Expand Down
10 changes: 4 additions & 6 deletions content/nap-waf/v5/admin-guide/deploy-on-kubernetes.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
description: This guide explains how to deploy F5 NGINX App Protect WAF v5 release in
a Kubernetes environment.
docs: DOCS-1366
doctypes:
- task
title: Deploying NGINX App Protect WAF on Kubernetes
weight: 300
toc: true
weight: 400
type: how-to
product: NAP-WAF
docs: DOCS-1366
---

## Prerequisites
Expand Down
87 changes: 87 additions & 0 deletions content/nap-waf/v5/admin-guide/install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: Installing NGINX App Protect WAF
weight: 200
toc: true
type: how-to
product: NAP-WAF
docs: DOCS-1363
---

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

{{%/tab%}}

{{%tab name="Alpine Linux 3.19"%}}

{{< include "nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-alpine" >}}

{{%/tab%}}

{{%tab name="Amazon Linux 2"%}}

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

{{%/tab%}}

{{%tab name="Alpine Linux 3.17"%}}

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

{{%/tab%}}

{{%tab name="Alpine Linux 3.19"%}}

{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}

3. Install the NGINX App Protect WAF v5 package:

```shell
sudo apk add app-protect-module-oss
```

{{%/tab%}}

{{%tab name="Amazon Linux 2"%}}

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

{{%/tab%}}

{{%tab name="Alpine Linux 3.19"%}}

{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-alpine.md" >}}

3. Install the NGINX App Protect WAF v5 package:

```shell
sudo apk add app-protect-module-plus
```

{{%/tab%}}

{{%tab name="Amazon Linux 2"%}}

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`:
Expand Down Expand Up @@ -697,6 +734,7 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
```

{{%/tab%}}

{{%tab name="Alpine Linux 3.17"%}}

{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}
Expand All @@ -710,6 +748,21 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
```

{{%/tab%}}

{{%tab name="Alpine Linux 3.19"%}}

{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md" >}}

3. Download all NGINX Open Source packages, including all dependencies:

```shell
sudo mkdir /etc/packages/
sudo apk update
sudo apk fetch --recursive --output /etc/packages app-protect-module-oss
```

{{%/tab%}}

{{%tab name="Amazon Linux 2"%}}

1. Create the file named `/etc/yum.repos.d/nginx.repo` with the following contents:
Expand Down Expand Up @@ -922,6 +975,21 @@ Please follow these steps before you install either NGINX Open Source or NGINX P
```

{{%/tab%}}

{{%tab name="Alpine Linux 3.19"%}}

{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-alpine.md" >}}

3. Download all NGINX Plus packages, including all dependencies:

```shell
sudo mkdir /etc/packages/
sudo apk update
sudo apk fetch --recursive --output /etc/packages app-protect-module-plus
```

{{%/tab%}}

{{%tab name="Amazon Linux 2023"%}}

{{< include "nap-waf/config/v5/host-based-nginx-instructions/nginx-plus-amzn2023.md" >}}
Expand Down Expand Up @@ -1295,6 +1363,25 @@ sudo apk del app-protect-module-plus
```

{{%/tab%}}

{{%tab name="Alpine Linux 3.19"%}}

For NGINX Open Source
Uninstall the NGINX App Protect WAF v5 package:

```shell
sudo apk del app-protect-module-oss
```

For NGINX Plus
Uninstall the NGINX App Protect WAF v5 package:

```shell
sudo apk del app-protect-module-plus
```

{{%/tab%}}

{{%tab name="Amazon Linux 2"%}}

For NGINX Open Source
Expand Down
11 changes: 5 additions & 6 deletions content/nap-waf/v5/admin-guide/overview.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
description: This guide explains how to deploy F5 NGINX App Protect WAF v5.
docs: DOCS-1362
doctypes:
- task
title: NGINX App Protect WAF Administration Guide
toc: true
weight: 100
toc: true
type: how-to
product: NAP-WAF
docs: DOCS-1362
---

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

| Distribution | Version |
| ------------ | ------------------- |
| Alpine | 3.17 |
| Alpine | 3.17, 3.19 |
| Debian | 11, 12 |
| Ubuntu | 20.04, 22.04, 24.04 |
| Amazon Linux | 2023 |
Expand Down
8 changes: 4 additions & 4 deletions content/nap-waf/v5/admin-guide/upgrade-nap-waf.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Upgrade NGINX App Protect WAF on Managed Instances"
description: "How to Upgrade F5 NGINX App Protect WAF on managed NGINX instances"
title: Upgrade NGINX App Protect WAF on Managed Instances
weight: 600
toc: true
tags: [ "NGINX Management Suite" ]
docs: "DOCS-1640"
type: how-to
product: NAP-WAF
docs: DOCS-1640
---

## Overview
Expand Down
Loading