Skip to content

Commit d39cae6

Browse files
ADubhlaoichliadlevif5JTorreGohad-peretsmjang
authored
NGINX App Protect WAF 5.6 / 4.14 (#280)
* Nap helm chart (#267) * feat: install nap 5 with helm chart * Update content/nap-waf/v5/admin-guide/deploy-on-kubernetes/deploy-with-helm.md Co-authored-by: Jon Torre <[email protected]> * feat: Add placeholders for NAP 5.6 / 4.14 release notes (#284) * feat: Restructure Kubernetes documentation IA, update references * feat: Re-order admin-guide pages * Update content/nap-waf/v4/releases/about-4.14.md * feat: Remove unnecessary item, move issues from known to resolved * feat: Update Generated Documentation (#301) Compiler 11.322.0-nap-release-4-14-0-13891737 (6d34e452) * Apply suggestions from code review Co-authored-by: ohad-perets <[email protected]> * feat: Update package names, move Go version bump to resolved issues * feat: Convert K8s configuration to includes for both cases * feat: Remove mention of Alpine 3.17 * feat: OS version consolidation, remove redundancy * feat: Add JWT step using includes * feat: Update text to be imperative * feat: Additional tab work for NAP5 installation * feat: Fix formatting of common steps * feat: Update release dates * Update deploy-on-docker.md removing && from DanielK's comments * Update deploy-on-docker.md remove also for plus * feat: Update package file versions * feat: Push additional documentation improvements * feat: Fix links * Update content/nap-waf/v5/releases/about-5.4.md * Update deploy-with-helm.md remove mtls & read-only references due to a bug, need to fix that after release * Update deploy-with-helm.md update login with jwt --------- Co-authored-by: liadlevif5 <[email protected]> Co-authored-by: Jon Torre <[email protected]> Co-authored-by: ohad-perets <[email protected]> Co-authored-by: Mike Jang <[email protected]>
1 parent 9ce9274 commit d39cae6

Some content is hidden

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

43 files changed

+1702
-2404
lines changed

‎content/includes/nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-alpine.md‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
1. Upload **nginx-repo.key** to **/etc/apk/cert.key** and **nginx-repo.crt** to **/etc/apk/cert.pem**. Make sure that files do not contain other certificates and keys: Alpine Linux does not support mixing client certificates for different repositories.
1+
Move **nginx-repo.key** to **/etc/apk/cert.key** and **nginx-repo.crt** to **/etc/apk/cert.pem**.
22

3-
2. Install prerequisite packages:
3+
Make sure that files do not contain other certificates and keys: Alpine Linux does not support mixing client certificates for different repositories.
44

5-
```shell
6-
sudo apk add openssl ca-certificates
7-
```
5+
Install prerequisite packages:
86

9-
3. Put NGINX signing public key to directory `/etc/apk/keys`:
7+
```shell
8+
sudo apk add openssl ca-certificates
9+
```
1010

11-
```shell
12-
sudo wget -O /etc/apk/keys/nginx_signing.rsa.pub https://cs.nginx.com/static/keys/nginx_signing.rsa.pub
13-
```
11+
Add the NGINX signing public key to the directory `/etc/apk/keys`:
12+
13+
```shell
14+
sudo wget -O /etc/apk/keys/nginx_signing.rsa.pub https://cs.nginx.com/static/keys/nginx_signing.rsa.pub
15+
```

‎content/includes/nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-amazon.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Create the `/etc/ssl/nginx/` directory:
2+
3+
```shell
4+
sudo mkdir -p /etc/ssl/nginx
5+
```
6+
7+
Upload the **nginx-repo.crt** and **nginx-repo.key** files to the `/etc/ssl/nginx/` directory.
8+
9+
Remove any previously downloaded NGINX repository files from `/etc/yum.repos.d`:
10+
11+
```shell
12+
sudo rm /etc/yum.repos.d/nginx*.repo
13+
sudo rm /etc/yum.repos.d/*app-protect*.repo
14+
```
15+
16+
Install the required dependencies:
17+
18+
```shell
19+
sudo dnf install ca-certificates wget
20+
```
21+
22+
Download the `dependencies.repo` file to `/etc/yum.repos.d`:
23+
24+
```shell
25+
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.amazonlinux2023.repo
26+
```

‎content/includes/nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-amzn2023.md‎

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎content/includes/nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-debian.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,50 @@
1-
1. Create the `/etc/ssl/nginx/` directory:
1+
Create the `/etc/ssl/nginx/` directory:
22

3-
```shell
4-
sudo mkdir -p /etc/ssl/nginx
5-
```
3+
```shell
4+
sudo mkdir -p /etc/ssl/nginx
5+
```
66

7-
2. Upload **nginx-repo.crt** and **nginx-repo.key** files to the `/etc/ssl/nginx/` directory.
7+
Upload **nginx-repo.crt** and **nginx-repo.key** files to the `/etc/ssl/nginx/` directory.
88

9-
3. Remove any previous NGINX repository and apt configuration files:
9+
Remove any previous NGINX repository and apt configuration files:
1010

11-
```shell
12-
sudo rm /etc/apt/sources.list.d/nginx*.list
13-
sudo rm /etc/apt/sources.list.d/*app-protect*.list
14-
sudo rm /etc/apt/apt.conf.d/90pkgs-nginx
15-
```
11+
```shell
12+
sudo rm /etc/apt/sources.list.d/nginx*.list
13+
sudo rm /etc/apt/sources.list.d/*app-protect*.list
14+
sudo rm /etc/apt/apt.conf.d/90pkgs-nginx
15+
```
1616

17-
4. Install prerequisite packages:
17+
Install prerequisite packages:
1818

19-
```shell
20-
sudo apt-get update && sudo apt-get install apt-transport-https lsb-release ca-certificates wget gnupg2 debian-archive-keyring
21-
```
19+
```shell
20+
sudo apt-get update && sudo apt-get install apt-transport-https lsb-release ca-certificates wget gnupg2 debian-archive-keyring
21+
```
2222

23-
5. Download and add the NGINX signing key:
23+
Download and add the NGINX signing key:
2424

25-
```shell
26-
wget -qO - https://cs.nginx.com/static/keys/nginx_signing.key | gpg --dearmor | \
27-
sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
28-
```
25+
```shell
26+
wget -qO - https://cs.nginx.com/static/keys/nginx_signing.key | gpg --dearmor | \
27+
sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
28+
```
2929

30-
6. Download the apt configuration to `/etc/apt/apt.conf.d`:
30+
Download the apt configuration to `/etc/apt/apt.conf.d`:
3131

32-
```shell
33-
sudo wget -P /etc/apt/apt.conf.d https://cs.nginx.com/static/files/90pkgs-nginx
34-
```
32+
```shell
33+
sudo wget -P /etc/apt/apt.conf.d https://cs.nginx.com/static/files/90pkgs-nginx
34+
```
3535

36-
7. Verify that the downloaded file contains the proper key:
36+
Verify that the downloaded file contains the proper key:
3737

38-
```shell
39-
gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg
40-
```
38+
```shell
39+
gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg
40+
```
4141

42-
The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows:
42+
The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows:
4343

44-
```none
45-
pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24]
46-
573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
47-
uid nginx signing key <[email protected]>
48-
```
44+
```none
45+
pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24]
46+
573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
47+
uid nginx signing key <[email protected]>
48+
```
4949

50-
If the fingerprint is different, remove the file.
50+
If the fingerprint is different, remove the file.

‎content/includes/nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-dnf.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
1. Create the `/etc/ssl/nginx` directory:
1+
Create the `/etc/ssl/nginx/` directory:
22

3-
```shell
4-
sudo mkdir -p /etc/ssl/nginx
5-
```
3+
```shell
4+
sudo mkdir -p /etc/ssl/nginx
5+
```
66

7-
2. Upload **nginx-repo.crt** and **nginx-repo.key** files to the `/etc/ssl/nginx/` directory.
7+
Upload **nginx-repo.crt** and **nginx-repo.key** files to the `/etc/ssl/nginx/` directory.
88

9-
3. Remove any previously downloaded NGINX repository files from `/etc/yum.repos.d`:
9+
Remove any previously downloaded NGINX repository files from `/etc/yum.repos.d`:
1010

11-
```shell
12-
sudo rm /etc/yum.repos.d/nginx*.repo
13-
sudo rm /etc/yum.repos.d/*app-protect*.repo
14-
```
11+
```shell
12+
sudo rm /etc/yum.repos.d/nginx*.repo
13+
sudo rm /etc/yum.repos.d/*app-protect*.repo
14+
```
1515

16-
4. Install required dependencies:
16+
Install required dependencies:
1717

18-
```shell
19-
sudo dnf install ca-certificates wget
20-
```
18+
```shell
19+
sudo dnf install ca-certificates wget
20+
```
2121

22-
5. Download the `dependencies.repo` file to `/etc/yum.repos.d`:
22+
Download the `dependencies.repo` file to `/etc/yum.repos.d`:
2323

24-
```shell
25-
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.repo
26-
```
24+
```shell
25+
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.repo
26+
```

‎content/includes/nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-rhel-cen-74.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
1. Create the `/etc/ssl/nginx` directory:
1+
Create the `/etc/ssl/nginx/` directory:
22

3-
```shell
4-
sudo mkdir -p /etc/ssl/nginx
5-
```
3+
```shell
4+
sudo mkdir -p /etc/ssl/nginx
5+
```
66

7-
2. Upload **nginx-repo.crt** and **nginx-repo.key** files to the `/etc/ssl/nginx/` directory.
7+
Upload **nginx-repo.crt** and **nginx-repo.key** files to the `/etc/ssl/nginx/` directory.
88

9-
3. Remove any previously downloaded NGINX repository files from `/etc/yum.repos.d`:
9+
Remove any previously downloaded NGINX repository files from `/etc/yum.repos.d`:
1010

11-
```shell
12-
sudo rm /etc/yum.repos.d/nginx*.repo
13-
sudo rm /etc/yum.repos.d/*app-protect*.repo
14-
```
11+
```shell
12+
sudo rm /etc/yum.repos.d/nginx*.repo
13+
sudo rm /etc/yum.repos.d/*app-protect*.repo
14+
```
1515

16-
4. Install required dependencies:
16+
Install required dependencies:
1717

18-
```shell
19-
sudo yum install ca-certificates wget
20-
```
18+
```shell
19+
sudo yum install ca-certificates wget
20+
```
2121

22-
5. Download the `dependencies.repo` file to `/etc/yum.repos.d`:
22+
Download the `dependencies.repo` file to `/etc/yum.repos.d`:
2323

24-
```shell
25-
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.repo
26-
```
24+
```shell
25+
sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/dependencies.repo
26+
```

‎content/includes/nap-waf/config/v5/host-based-nginx-instructions/common-steps-with-ubuntu.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,50 @@
1-
1. Create the `/etc/ssl/nginx/` directory:
1+
Create the `/etc/ssl/nginx/` directory:
22

3-
```shell
4-
sudo mkdir -p /etc/ssl/nginx
5-
```
3+
```shell
4+
sudo mkdir -p /etc/ssl/nginx
5+
```
66

7-
2. Upload **nginx-repo.crt** and **nginx-repo.key** files to the `/etc/ssl/nginx/` directory.
7+
Upload **nginx-repo.crt** and **nginx-repo.key** files to the `/etc/ssl/nginx/` directory.
88

9-
3. Remove any previous NGINX repository and apt configuration files:
9+
Remove any previous NGINX repository and apt configuration files:
1010

11-
```shell
12-
sudo rm /etc/apt/sources.list.d/nginx*.list
13-
sudo rm /etc/apt/sources.list.d/*app-protect*.list
14-
sudo rm /etc/apt/apt.conf.d/90pkgs-nginx
15-
```
11+
```shell
12+
sudo rm /etc/apt/sources.list.d/nginx*.list
13+
sudo rm /etc/apt/sources.list.d/*app-protect*.list
14+
sudo rm /etc/apt/apt.conf.d/90pkgs-nginx
15+
```
1616

17-
4. Install prerequisite packages:
17+
Install prerequisite packages:
1818

19-
```shell
20-
sudo apt-get update && sudo apt-get install apt-transport-https lsb-release ca-certificates wget gnupg2 ubuntu-keyring
21-
```
19+
```shell
20+
sudo apt-get update && sudo apt-get install apt-transport-https lsb-release ca-certificates wget gnupg2 ubuntu-keyring
21+
```
2222

23-
5. Download and add the NGINX signing key:
23+
Download and add the NGINX signing key:
2424

25-
```shell
26-
wget -qO - https://cs.nginx.com/static/keys/nginx_signing.key | gpg --dearmor | \
27-
sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
28-
```
25+
```shell
26+
wget -qO - https://cs.nginx.com/static/keys/nginx_signing.key | gpg --dearmor | \
27+
sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
28+
```
2929

30-
6. Download the apt configuration to `/etc/apt/apt.conf.d`:
30+
Download the apt configuration to `/etc/apt/apt.conf.d`:
3131

32-
```shell
33-
sudo wget -P /etc/apt/apt.conf.d https://cs.nginx.com/static/files/90pkgs-nginx
34-
```
32+
```shell
33+
sudo wget -P /etc/apt/apt.conf.d https://cs.nginx.com/static/files/90pkgs-nginx
34+
```
3535

36-
7. Verify that the downloaded file contains the proper key:
36+
Verify that the downloaded file contains the proper key:
3737

38-
```shell
39-
gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg
40-
```
38+
```shell
39+
gpg --dry-run --quiet --no-keyring --import --import-options import-show /usr/share/keyrings/nginx-archive-keyring.gpg
40+
```
4141

42-
The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows:
42+
The output should contain the full fingerprint `573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62` as follows:
4343

44-
```none
45-
pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24]
46-
573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
47-
uid nginx signing key <[email protected]>
48-
```
44+
```none
45+
pub rsa2048 2011-08-19 [SC] [expires: 2027-05-24]
46+
573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62
47+
uid nginx signing key <[email protected]>
48+
```
4949

50-
If the fingerprint is different, remove the file.
50+
If the fingerprint is different, remove the file.

‎content/includes/nap-waf/config/v5/host-based-nginx-instructions/nginx-oss-alpine.md‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
1-
1. Set up the apk repository for mainline nginx packages:
1+
Set up the apk repository for mainline nginx packages:
22

3-
```shell
4-
printf "%s%s%s\n" \
5-
"http://nginx.org/packages/mainline/alpine/v" \
6-
`egrep -o '^[0-9]+\.[0-9]+' /etc/alpine-release` \
7-
"/main" \
8-
| sudo tee -a /etc/apk/repositories
9-
```
3+
```shell
4+
printf "%s%s%s\n" \
5+
"http://nginx.org/packages/mainline/alpine/v" \
6+
`egrep -o '^[0-9]+\.[0-9]+' /etc/alpine-release` \
7+
"/main" \
8+
| sudo tee -a /etc/apk/repositories
9+
```
1010

11-
2. Add the NGINX App Protect WAF v5 apk repository:
11+
Add the NGINX App Protect WAF v5 apk repository:
1212

13-
```shell
14-
printf "https://pkgs.nginx.com/app-protect-x-oss/alpine/v`egrep -o '^[0-9]+\.[0-9]+' /etc/alpine-release`/main\n" | sudo tee -a /etc/apk/repositories
15-
```
13+
```shell
14+
printf "https://pkgs.nginx.com/app-protect-x-oss/alpine/v`egrep -o '^[0-9]+\.[0-9]+' /etc/alpine-release`/main\n" | sudo tee -a /etc/apk/repositories
15+
```
16+
17+
Install the NGINX App Protect WAF v5 package:
18+
19+
```shell
20+
sudo apk add app-protect-module-oss
21+
```

0 commit comments

Comments
 (0)