Skip to content

Commit aa4fcc6

Browse files
authored
Merge branch 'main' into mjang-patch-4
2 parents bd16de1 + 613d1d0 commit aa4fcc6

File tree

3 files changed

+66
-12
lines changed

3 files changed

+66
-12
lines changed

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/solutions/about-subscription-licenses.md

Lines changed: 44 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,18 @@ We’re updating NGINX Plus to align with F5’s entitlement and visibility poli
1414

1515
Starting with NGINX Plus R33, all **NGINX Plus instances require a valid JSON Web Token (JWT) license**. This license is tied to your subscription (not individual instances) and is used to validate your subscription and automatically send usage reports to F5's licensing endpoint (`product.connect.nginx.com`), as required by your subscription agreement. In offline environments, usage reporting is [routed through NGINX Instance Manager]({{< ref "nim/disconnected/report-usage-disconnected-deployment.md" >}}).
1616

17-
### Important changes
17+
## Important changes
1818

19-
##### NGINX Plus won't start if:
19+
If you have multiple subscriptions, you’ll also have multiple JWT licenses. You can assign each NGINX Plus instance to the license you prefer. NGINX combines usage reporting across all licensed instances.
20+
21+
This feature is available in NGINX Instance Manager 2.20 and later.
22+
23+
### NGINX Plus won't start if:
2024

2125
- The JWT license is missing or invalid.
2226
- The JWT license expired over 90 days ago.
2327

24-
##### NGINX Plus will **stop processing traffic** if:
28+
### NGINX Plus will **stop processing traffic** if:
2529

2630
- It can't submit an initial usage report to F5's licensing endpoint or NGINX Instance Manager.
2731

@@ -41,17 +45,48 @@ When installing or upgrading to NGINX Plus R33 or later, take the following step
4145

4246
---
4347

44-
## Add the JWT license {#add-jwt}
48+
## Download the license from MyF5 {#download-jwt}
4549

46-
Before you install or upgrade to NGINX Plus R33 or later, make sure to:
50+
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
4751

48-
### Download the license from MyF5 {#download-jwt}
52+
---
4953

50-
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
54+
## Deploy the JWT license
55+
56+
After you download the JWT license, you can deploy it to your NGINX Plus instances using either of the following methods:
57+
58+
- Use a **Config Sync Group** if you're managing instances with the NGINX One Console (recommended)
59+
- Copy the license manually to each instance
60+
61+
Each method ensures your NGINX Plus instances have access to the required license file.
62+
63+
### Deploy with a Config Sync Group (Recommended)
64+
65+
If you're using the [NGINX One Console]({{< ref "/nginx-one/getting-started.md" >}}), the easiest way to manage your JWT license is with a [Config Sync Group]({{< ref "/nginx-one/nginx-configs/config-sync-groups/manage-config-sync-groups.md" >}}). This method lets you:
66+
67+
- Avoid manual file copying
68+
- Keep your fleet consistent
69+
- Automatically apply updates to new NGINX Plus instances
70+
71+
To deploy the JWT license with a Config Sync Group:
72+
73+
{{< include "/licensing-and-reporting/deploy-jwt-with-csgs.md" >}}
74+
75+
Your JWT license now syncs to all NGINX Plus instances in the group.
76+
77+
When your subscription renews and a new JWT license is issued, update the file in the Config Sync Group to apply the change across your fleet.
78+
79+
New instances added to the group automatically inherit the license.
80+
81+
{{< call-out "note" "If you’re using NGINX Instance Manager" "" >}}
82+
If you're using NGINX Instance Manager instead of the NGINX One Console, the equivalent feature is called an *instance group*. You can manage your JWT license in the same way by adding or updating the file in the instance group. For details, see [Manage instance groups]({{< ref "/nim/nginx-instances/manage-instance-groups.md" >}}).
83+
{{< /call-out >}}
84+
85+
### Copy the license manually
5186

52-
### Copy the license to each NGINX Plus instance
87+
If you're not using the NGINX One Console, copy the JWT license file to each NGINX Plus instance manually.
5388

54-
{{< include "licensing-and-reporting/apply-jwt.md" >}}
89+
{{< include "/licensing-and-reporting/apply-jwt.md" >}}
5590

5691
### Custom paths {#custom-paths}
5792

0 commit comments

Comments
 (0)