Skip to content

Commit 99c7e0e

Browse files
authored
Merge branch 'main' into update-agent-v2-installation-docs
2 parents f551585 + af23317 commit 99c7e0e

File tree

21 files changed

+324
-65
lines changed

21 files changed

+324
-65
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ To understand how we use Git in this repository, read our [Git conventions](/doc
4141
The broad workflow is as follows:
4242

4343
- Fork the NGINX repository
44+
- If you're an F5/NGINX user, you can work from a clone
4445
- Create a branch
4546
- Implement your changes in your branch
4647
- Submit a pull request (PR) when your changes are ready for review

content/includes/licensing-and-reporting/apply-jwt.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
---
2-
docs:
32
file:
43
- content/solutions/about-subscription-licenses.md
54
- content/nap-waf/v5/admin-guide/install.md
65
---
76

8-
1. Copy the license file to `/etc/nginx/license.jwt` on Linux or `/usr/local/etc/nginx/license.jwt` on FreeBSD for each NGINX Plus instance.
9-
2. Reload NGINX:
7+
1. Copy the license file to:
8+
9+
- `/etc/nginx/license.jwt` on Linux
10+
- `/usr/local/etc/nginx/license.jwt` on FreeBSD
11+
12+
1. Reload NGINX:
1013

1114
```shell
1215
systemctl reload nginx
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
file:
3+
- content/solutions/about-subscription-licenses.md
4+
---
5+
6+
1. In the NGINX One Console, go to **Manage > Config Sync Groups**, then select your group.
7+
8+
If you haven't created a Config Sync Group yet, see [Manage Config Sync Groups]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}) for setup instructions.
9+
2. Select the **Configuration** tab, then choose **Edit Configuration**.
10+
3. Select **Add File**, then choose **New Configuration File**.
11+
4. In the **File name** field, enter:
12+
- On Linux: `/etc/nginx/license.jwt`
13+
- On FreeBSD: `/usr/local/etc/nginx/license.jwt`
14+
The name must be exact.
15+
5. Paste the contents of your JWT license file into the editor.
16+
6. Select **Next** to preview the diff, then **Save and Publish** to apply the update.

content/includes/nim/tech-specs/supported-distros.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,12 @@ The following table lists the Linux distributions supported by NGINX Instance Ma
88

99
{{<bootstrap-table "table table-striped table-bordered">}}
1010

11-
| Distribution | Version | Architecture | NGINX Instance Manager Support | NGINX App Protect Support |
12-
|-----------------|----------------------------------------|------------------|---------------------------------------------------|----------------------------------------------------|
13-
| Amazon Linux | 2 LTS | x86_64 | Supported | **Support discontinued as of 2.18.0** |
14-
| CentOS | 7.4 and later in the 7.x family | x86_64 | **Support discontinued as of 2.17.0** | **Support discontinued as of 2.17.0** |
15-
| Debian | 11<hr>12 | x86_64<hr>x86_64 | Supported<hr>Supported on 2.13.0+ | Supported<hr>Supported |
16-
| Oracle Linux | 7.4 and later in the 7.x family<hr>8.0 and later in the 8.x family | x86_64<hr>x86_64 | **Support discontinued as of 2.17.0**<hr>Supported on 2.6.0+ | **Support discontinued as of 2.17.0**<hr>Supported |
17-
| RHEL | 7.4 and later in the 7.x family<hr>8.x and later in the 8.x family<hr>9.x and later in the 9.x family | x86_64<hr>x86_64<hr>x86_64 | **Support discontinued as of 2.17.0**<hr>Supported<hr>Supported on 2.6.0+ | **Support discontinued as of 2.17.0**<hr>Supported<hr>Supported |
18-
| Ubuntu | 20.04<hr>22.04<hr>24.04 | x86_64<hr>x86_64<hr>x86_64 | Supported<hr>Supported on 2.3.0+<hr>Supported on 2.18.0+ | **Support discontinued as of NAP 4.15.0/5.7.0**<hr>Supported<hr>Supported |
11+
| Distribution | Version | Architecture | NGINX Instance Manager Support | NGINX App Protect Support |
12+
|-----------------|----------------------------------------|------------------|-----------------------------------------------------|----------------------------------------------------|
13+
| Debian | 11<hr>12 | x86_64<hr>x86_64 | Supported<hr>Supported | Supported<hr>Supported |
14+
| Oracle Linux | 8.0 and later in the 8.x family | x86_64 | Supported | Supported |
15+
| RHEL | 8.0 and later in the 8.x family<hr>9.0 and later in the 9.x family | x86_64<hr>x86_64 | Supported<hr>Supported | Supported<hr>Supported |
16+
| Ubuntu | 22.04<hr>24.04 | x86_64<hr>x86_64 | Supported<hr>Supported on 2.18.0+ | Supported<hr>Supported |
1917

2018
{{</bootstrap-table>}}
2119

content/nginx-one/connect-instances/set-up-nginx-proxy-for-nginx-one.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,19 +69,38 @@ To set up your other NGINX instances to use the proxy instance to connect to NGI
6969
2. Open the NGINX Agent configuration file (**/etc/nginx-agent/nginx-agent.conf**) with a text editor.
7070
3. Add the following configuration. Replace `YOUR_DATA_PLANE_KEY_HERE` with your actual data plane key and `YOUR_PROXY_IP_ADDRESS_HERE` with the IP address of the NGINX proxy instance.
7171
72-
```yaml
72+
{{< tabs name="Configure NGINX Agent to use the proxy" >}}
73+
74+
{{%tab name="NGINX Agent 3.x"%}}
75+
76+
```yaml
77+
command:
78+
server:
79+
# Replace YOUR_PROXY_IP_ADDRESS_HERE with the IP address of the NGINX proxy instance.
80+
host: YOUR_PROXY_IP_ADDRESS_HERE
81+
port: 5000
82+
auth:
83+
# Replace YOUR_DATA_PLANE_KEY_HERE with your NGINX One Console data plane key.
84+
token: "YOUR_DATA_PLANE_KEY_HERE"
85+
tls:
86+
skip_verify: False
87+
```
88+
89+
{{%/tab%}}
90+
{{%tab name="NGINX Agent 2.x"%}}
91+
```yaml
7392
server:
7493
# Replace YOUR_DATA_PLANE_KEY_HERE with your NGINX One Data Plane Key.
7594
token: "YOUR_DATA_PLANE_KEY_HERE"
7695
# Replace YOUR_PROXY_IP_ADDRESS_HERE with the IP address of the NGINX proxy instance.
7796
host: YOUR_PROXY_IP_ADDRESS_HERE
7897
grpcPort: 5000
79-
command: agent.connect.nginx.com
80-
metrics: agent.connect.nginx.com
8198
tls:
82-
enable: true
83-
skip_verify: false
84-
```
99+
enable: True
100+
skip_verify: False
101+
```
102+
{{%/tab%}}
103+
{{%/tabs%}}
85104
86105
4. Restart NGINX Agent:
87106

content/nginx/admin-guide/installing-nginx/installing-nginx-plus-amazon-web-services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To quickly set up an NGINX Plus environment on AWS:
3838
/etc/init.d/nginx status
3939
```
4040

41-
See [NGINX Plus on the AWS Cloud Quick Start](https://aws.amazon.com/quickstart/architecture/nginx-plus/) deployment guide for details.
41+
See [NGINX Plus on the AWS Cloud Quick Start](https://aws.amazon.com/blogs/apn/introducing-a-new-aws-quick-start-nginx-plus-on-the-aws-cloud-in-15-minutes/) deployment guide for details.
4242

4343
## What If I Need Help?
4444

content/nginx/deployment-guides/single-sign-on/oidc-njs/active-directory-federation-services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ See [Single Sign-On With Microsoft AD FS]({{< ref "nginx/deployment-guides/singl
1616

1717
This guide explains how to enable single sign-on (SSO) for applications being proxied by F5 NGINX Plus. The solution uses OpenID Connect as the authentication mechanism, with [Microsoft Active Directory Federation Services](https://docs.microsoft.com/en-us/windows-server/identity/active-directory-federation-services) (AD FS) as the identity provider (IdP) and NGINX Plus as the relying party.
1818

19-
{{< see-also >}}{{< readfile file="includes/nginx-openid-repo-note.txt" markdown="true" >}}{{< /see-also >}}
19+
{{< see-also >}}{{<include "nginx-plus/nginx-openid-repo-note">}}{{< /see-also >}}
2020

2121
<span id="prereqs"></span>
2222
## Prerequisites

content/nginx/deployment-guides/single-sign-on/oidc-njs/auth0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ See [Single Sign-On With Auth0]({{< ref "nginx/deployment-guides/single-sign-on/
1616

1717
You can use F5 NGINX Plus with [Auth0](https://auth0.com/) and OpenID Connect to enable single sign-on (SSO) for your proxied applications. By following the steps in this guide, you will learn how to set up SSO using OpenID Connect as the authentication mechanism, with Auth0 as the identity provider (IdP), and NGINX Plus as the relying party.
1818

19-
{{< see-also >}}{{< readfile file="includes/nginx-openid-repo-note.txt" markdown="true" >}}{{< /see-also >}}
19+
{{< see-also >}}{{<include "nginx-plus/nginx-openid-repo-note">}}{{< /see-also >}}
2020

2121
## Prerequisites
2222

content/nginx/deployment-guides/single-sign-on/oidc-njs/cognito.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ See [Single Sign-On With Amazon Cognito]({{< ref "nginx/deployment-guides/single
1616

1717
This guide explains how to enable single sign‑on (SSO) for applications being proxied by F5 NGINX Plus. The solution uses OpenID Connect as the authentication mechanism, with [Amazon Cognito](https://aws.amazon.com/cognito/) as the identity provider (IdP), and NGINX Plus as the relying party.
1818

19-
{{< see-also >}}{{< readfile file="includes/nginx-openid-repo-note.txt" markdown="true" >}}{{< /see-also >}}
19+
{{< see-also >}}{{<include "nginx-plus/nginx-openid-repo-note">}}{{< /see-also >}}
2020

2121

2222
<span id="prereqs"></span>

0 commit comments

Comments
 (0)