Skip to Content

Self-Hosted Deployment

Manage your self-hosted license

Add or renew the license key of a self-hosted Databrain install, and know what happens when it ends.

Before you start

  • You run Databrain on your own servers. Settings > License exists only on self-hosted installs.
  • You are an Admin to turn license updates on or off.

Get a license key

  1. Go to Settings > License.
  2. Under Instance ID, select Copy.
  3. Send the instance ID to Databrain support. Or select Email Databrain support.

Databrain sends you a license key, or a license file for a server with no internet.

Add or replace the key

  1. Go to Settings > License.
  2. In Add your license key (or Replace the license key), paste the key in License key.
  3. Select Save key.

You see “License key saved.” The status shows Licensed and Valid until shows the end date.

No internet on the server: select Upload license file and pick the .lic or .txt file Databrain sent. The file must be smaller than 16 KB.

You can also set the key in the LICENSE_KEY environment variable on the backend. When both are set, the newer license wins.

Get renewals by themselves

  1. Go to Settings > License > License updates.
  2. Turn on Get license updates from Databrain.

The server asks Databrain for its current license every 30 minutes. A renewal arrives with no key to paste. Select Check for a renewal to ask now. Select What this server sends, for your firewall to see the address and the data. It sends the image version and the time, with the license key as the credential. It sends no customer data.

Connection to Databrain shows the result: Connected, Cannot reach Databrain, Not recognised, Waiting, Checking or Off. After 7 days with no successful check, the page warns you.

To block license updates on the server, set DATABRAIN_LICENSE_CHECK_IN=off on the backend.

License status

StatusWhat it meansWhat to do
LicensedThe license is validNothing
Expiring soonIt ends within 30 days. Within 7 days the warning turns urgentAsk Databrain to renew it
Grace periodIt ended less than 14 days ago. Everything still worksRenew now
Expired / RevokedThe grace period is overRenew. Sign-in, dashboards, embeds and API keys keep working. Paid features turn off
No license yetA new install in its 15-day trialGet a key before the trial ends
No licenseThe trial ended and no key was ever savedAdd a key. Until then, sign-in and embeds are refused
Not validThe saved key was not issued for this server, or was changedPaste the key Databrain sent you, or ask for a new one with your instance ID

If something goes wrong

  • “Invalid License Key”. Copy the key again with no spaces or line breaks.
  • “This license key is not bound to this account. Sign in as an admin to apply it.” The key belongs to another organization. Sign in as an admin of the right organization, or ask Databrain for a key for this instance ID.
  • “This file is too large to be a license file.” / “This file does not contain a license key.” Upload the file Databrain sent, not another file.
  • Sign-in shows “Your license has expired”. Paste a valid key in Key on that screen and select Submit.
  • API calls answer LICENSE_EXPIRED (“Trial or License Key is Expired!”). The trial ended with no license. Add a key.