From a0ad81180ed42ced08a6a788c044cbb87ff58fc4 Mon Sep 17 00:00:00 2001 From: Emil Tullstedt Date: Thu, 30 Jan 2020 09:41:59 +0100 Subject: [PATCH] Docs: Add information about license expiration (#21578) * Docs: Add information about license expiration * Docs: Improve clarity of license expiration page * review comments * change renewal instructions to a list * language improvements * review fixes --- docs/sources/enterprise/license-expiration.md | 54 +++++++++++++++++++ docs/sources/menu.yaml | 2 + 2 files changed, 56 insertions(+) create mode 100644 docs/sources/enterprise/license-expiration.md diff --git a/docs/sources/enterprise/license-expiration.md b/docs/sources/enterprise/license-expiration.md new file mode 100644 index 00000000000..2f4b532a349 --- /dev/null +++ b/docs/sources/enterprise/license-expiration.md @@ -0,0 +1,54 @@ ++++ +title = "License Expiration" +description = "" +keywords = ["grafana", "licensing"] +type = "docs" +[menu.docs] +parent = "enterprise" +weight = 8 ++++ + +# License expiration + +If your license has expired most of Grafana keeps working as normal. Some enterprise functionality stops or runs with reduced functionality and Grafana displays a banner informing the users that Grafana is running on an expired license. Your Grafana admin needs to upload a new license file to restore full functionality. + +> Replace your license as soon as possible. Running Grafana Enterprise with an expired license is unsupported and can lead to unexpected consequences. + +## Replacing your license + +1. Locate your current `license.jwt` file. In a standard installation it is stored inside Grafana's data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration](https://grafana.com/docs/grafana/latest/installation/configuration/) +``` +[enterprise] +license_path = /path/to/your/license.jwt +``` +The configuration file's location may also be overridden by the `GF_ENTERPRISE_LICENSE_PATH` environment variable. +2. Log in to your [Grafana.com](https://grafana.com/login) user and make sure you're in the correct organization in the dropdown at the top of the page. +3. Under the **Grafana Enterprise** section in the menu bar to the left, choose licenses and download the currently valid license with which you want to run Grafana. If you cannot see a valid license on Grafana.com, please contact your account manager at Grafana Labs to renew your subscription. +4. Replace the current `license.jwt`-file with the one you've just downloaded. +5. Restart Grafana. + +## Data source permissions + +Your current data source permissions will keep working as expected, but you'll be unable to add new data source permissions until the license has been renewed. + +## Reporting + +- You're unable to configure new reports or generate previews. +- Scheduled reports are not generated or sent. + +## SAML authentication + +SAML is not affected by an expired license. + +## LDAP authentication + +- LDAP synchronization is not affected by an expired license. +- Enhanced LDAP debugging is unavailable. + +## Enterprise plugins + +Enterprise plugins might stop working. + +## White labeling + +The white labeling feature is turned off, meaning that any white labeling options will not have any effect. diff --git a/docs/sources/menu.yaml b/docs/sources/menu.yaml index 283909bafee..d60005d5541 100644 --- a/docs/sources/menu.yaml +++ b/docs/sources/menu.yaml @@ -241,6 +241,8 @@ name: Team Sync - link: /enterprise/white-labeling/ name: White labeling + - link: /enterprise/license-expiration/ + name: License expiration - name: Tutorials link: /tutorials/ children: