License keys

v5.8 Enterprise

Self-hosted Unleash Enterprise uses license keys to ensure you comply with the terms of your contract. You get and manage license keys for your self-hosted trials and instances in License Hub.

License policy

License keys check compliance with the following aspects of the customer agreement:

• Seat count: the number of licensed users
• Contract duration: whether the license is within the contract expiration date

The seat count and contract duration parameters are encoded into the license key. Therefore, if you change your seat count or renew your contract, you must install a new license.

Each Unleash instance requires a separate license key. For example, a development or production instance must have separate keys.

License enforcement

v6.7

Mandatory license

If you don’t have a valid license, your Unleash instance enters read-only mode, and the only available action is to install a valid license.

License expiration

When your license expires, your Unleash instance enters read-only mode. The only available action is to install a new, valid license. Connected applications continue to operate and receive current feature flags, but users cannot make any changes to Unleash.

Seat count

If you reach the maximum number of seats included in your license, you cannot add new users until existing users are removed to stay within your limit.

The Unleash Admin UI displays a banner if you do not comply with your license. In addition, you receive a warning in advance if less than 10% of your available seats remain, your license is 30 days or less from expiration, or if you are running on a trial license.

License Hub

License Hub is where you manage the license keys for your self-hosted Unleash Enterprise instances. Sign in with Google, GitHub, or your email address. Your License Hub account belongs to your company, and everyone who is a license manager for the company sees the same licenses.

License Hub has two tabs:

• Licenses: lists your instances. Each instance has a license with its plan, status, seat count, creation date, expiry date, and license key. The page also walks you through starting Unleash, logging in, and installing the license.
• License Managers: lists the people who can manage your company’s licenses and invoices. License managers do not get access to the Unleash instances themselves.

Start a trial

To try self-hosted Unleash Enterprise, sign up for License Hub. License Hub creates a company account and a trial license for your first instance. The license card shows how many days are left on the trial and the number of seats it includes.

To upgrade a trial to a paid plan, click Upgrade to paid plan on the license card.

Add an instance

Each Unleash instance needs its own license key. To license another instance, such as a production instance alongside your development instance, go to the Licenses tab and click Add new instance. Click Edit on an instance to change its name.

Get your license key

In the Licenses tab, find the instance and click Copy next to License key. Then install the key in your Unleash instance.

Add a license manager

To let a colleague manage your company’s licenses and invoices, go to the License Managers tab, enter their email address, and click Add license manager. The table shows when each license manager joined and when they last logged in.

Get a new license

If you are starting out or adding an instance, get your license key from License Hub.

If you have an existing contract and are changing your agreement, such as the seat count or the contract expiration, contact your account representative to obtain the required license key. You can also reach out to license@getunleash.io.

Check your current license

To check your current license in the Unleash Admin UI, go to Admin settings > Instance config > License. If you have an active license, you’ll see the following information:

• Customer name
• Plan
• Seat count
• License expiration date

Update your license

Using the Admin UI

In the Unleash Admin UI, do the following:

1. Go to Admin settings > Instance config > License.
2. Paste the new license key and click Update license key.

After updating a license key, you may need to refresh your browser for the license warning banners to be removed.

Using an environment variable

You can also install or update your license key on container deployment, using the environment variable UNLEASH_LICENSE. If you attempt to update your license with an invalid or older one, your existing license will remain in effect.

For security reasons, if using Helm charts or Docker Compose to deploy Unleash, set up the license key as a secret and reference it in the Helm configuration values.yaml files or in docker-compose.yml.