Skip to content
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
8 changes: 6 additions & 2 deletions content/includes/licensing-and-reporting/apply-jwt.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ file:
- content/nap-waf/v5/admin-guide/install.md
---

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.
2. Reload NGINX:
1. Copy the license file to:

- `/etc/nginx/license.jwt` on Linux
- `/usr/local/etc/nginx/license.jwt` on FreeBSD

1. Reload NGINX:

```shell
systemctl reload nginx
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
docs:
file:
- content/solutions/about-subscription-licenses.md
---

1. In the NGINX One Console, go to **Manage > Config Sync Groups**, then select your group.

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.
2. Select the **Configuration** tab, then choose **Edit Configuration**.
3. Select **Add File**, then choose **New Configuration File**.
4. In the **File name** field, enter:
- On Linux: `/etc/nginx/license.jwt`
- On FreeBSD: `/usr/local/etc/nginx/license.jwt`
The name must be exact.
5. Paste the contents of your JWT license file into the editor.
6. Select **Next** to preview the diff, then **Save and Publish** to apply the update.
51 changes: 41 additions & 10 deletions content/solutions/about-subscription-licenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ We’re updating NGINX Plus to align with F5’s entitlement and visibility poli

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" >}}).

## Important changes

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.

This feature is available in NGINX Instance Manager 2.20 and later.

### Important changes

##### NGINX Plus won't start if:
### NGINX Plus won't start if:

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

##### NGINX Plus will **stop processing traffic** if:
### NGINX Plus will **stop processing traffic** if:

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

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

---

## Add the JWT license {#add-jwt}
## Download the license from MyF5 {#download-jwt}

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

### Download the license from MyF5 {#download-jwt}
---

{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}}
## Deploy the JWT license

After you download the JWT license, you can deploy it to your NGINX Plus instances using either of the following methods:

- Use a **Config Sync Group** if you're managing instances with the NGINX One Console (recommended)
- Copy the license manually to each instance

Each method ensures your NGINX Plus instances have access to the required license file.

### Deploy with a Config Sync Group (Recommended)

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:

- Avoid manual file copying
- Keep your fleet consistent
- Automatically apply updates to new NGINX Plus instances

To deploy the JWT license with a Config Sync Group:

{{< include "/licensing-and-reporting/deploy-jwt-with-csgs.md" >}}

Your JWT license now syncs to all NGINX Plus instances in the group.

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.

New instances added to the group automatically inherit the license.

{{< call-out "note" "If you’re using NGINX Instance Manager" "" >}}
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" >}}).
{{< /call-out >}}

### Copy the license manually

### Copy the license to each NGINX Plus instance
If you're not using NGINX One, copy the JWT license file to each NGINX Plus instance manually.

{{< include "licensing-and-reporting/apply-jwt.md" >}}
{{< include "/licensing-and-reporting/apply-jwt.md" >}}

### Custom paths {#custom-paths}

Expand Down