grafana/docs/sources/enterprise/activate-license.md
Emil Tullstedt 2a55e00c78
Licensing: Document new v7.4 options and APIs (#30217)
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2021-01-19 18:09:05 +01:00

3.1 KiB

+++ title = "Activate an Enterprise license" description = "Activate an Enterprise license" keywords = ["grafana", "licensing", "enterprise"] weight = 7 +++

Activate an Enterprise license

Follow these steps to activate your Grafana Enterprise license:

Step 1. Download your license file

To download your Grafana Enterprise license:

  1. Log in to your Grafana Cloud Account.
  2. Go to your Org Profile.
  3. Go to the section for Grafana Enterprise licenses in the side menu.
  4. At the bottom of the license details page there is Download Token link that will download the license.jwt file containing your license to your computer.

Step 2. Add your license to a Grafana instance

There are three different ways to add the license to a Grafana instance:

Upload the license file through the Grafana Server Administrator page

This is the preferred option for single instance installations of Grafana Enterprise.

  1. Sign in as a Grafana server admin.
  2. Navigate to Server Admin > Upgrade within Grafana.
  3. Click Upload license token file.
  4. Select your license file, and upload it.

Place the license.jwt file in Grafana's data folder

The data folder is usually /var/lib/grafana on Linux systems.

You can also configure a custom location for the license file using the grafana.ini setting:

[enterprise]
license_path = /company/secrets/license.jwt

This setting can also be set with an environment variable, which is useful if you're running Grafana with Docker and have a custom volume where you have placed the license file. In this case, set the environment variable GF_ENTERPRISE_LICENSE_PATH to point to the location of your license file.

Set the content of the license file as a configuration option

You can add a license by pasting the content of the license.jwt to the grafana.ini configuration file:

[enterprise]
license_text = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0aGlzIjoiaXMiLCJub3QiOiJhIiwidmFsaWQiOiJsaWNlbnNlIn0.bxDzxIoJlYMwiEYKYT_l2s42z0Y30tY-6KKoyz9RuLE

This option can be set using the GF_ENTERPRISE_LICENSE_TEXT environment variable.

Step 3. Ensure that the license file's root URL matches the root_url configuration option

Update the [root_url]({{< relref "../administration/configuration/#root-url" >}}) in your configuration. It should be the URL that users type in their browsers to access the frontend, not the node hostname(s).

This is important, because as part of the validation checks at startup, Grafana compares the license URL to the [root_url]({{< relref "../administration/configuration/#root-url" >}}) in your configuration.

In your configuration file:

[server]
root_url = https://grafana.blah.com/

Or with an environment variable:

GF_SERVER_ROOT_URL=https://grafana.blah.com/

Step 4. Restart Grafana

To finalize the installation of Grafana Enterprise, restart Grafana to enable all Grafana Enterprise features.

On Linux, when installed as a Systemd service you can restart Grafana by running sudo systemctl restart grafana-server.service.