Air-Gapped License Application

Air-gapped Rocket.Chat workspaces require an offline license to unlock premium features. This guide explains how to:

• Obtain your workspace license

• Generate a hashed workspace URL for added privacy

• Apply the license via the admin UI or deployment environment variables

If you don’t have a license yet, contact the Rocket.Chat Sales team with your workspace URL to subscribe to a premium plan. You can also activate a trial on your workspace to explore the additional features. Once you have the license, you can proceed to apply it in your workspace.

Hash your workspace URL for privacy

If you cannot share your actual workspace URL with Rocket.Chat Sales team due to privacy concerns, you can provide a SHA-256 hash instead. This hash is non-reversible, meaning Rocket.Chat cannot see your original domain.

To generate the hash value for your workspace URL, follow the respective steps for your OS described below.

$domain = "your-workspace-domain"
$bytes = [System.Text.Encoding]::UTF8.GetBytes($domain)
$sha256 = [System.Security.Cryptography.SHA256]::Create()
$hashBytes = $sha256.ComputeHash($bytes)
$hashString = [BitConverter]::ToString($hashBytes) -replace "-", ""
$hashString.ToLower()

• Remove http:// or https:// from the workspace domain. For example, example.rocket.chat.

• It is recommended that you run the command more than once to ensure the same hash output.

Finally, contact our Sales team with the hashed URL to provide a license token for you. Once you have your license, you must apply it using a deployment enviroment variable.

Apply license in an air-gapped workspace

Once you've received your license token, you need to apply it to your workspace. For air-gapped workspaces, you can apply the license in one of two ways:

• Via the workspace UI

• Via deployment environment variable

Apply license via the workspace UI

After registering and accessing your workspace, follow the steps below to apply your premium license:

1. Navigate to Administration > Settings > Premium in your workspace.

2. Paste your License Token into the Premium License field.

3. Click Save Changes.

4. Confirm that the Status of the license displays as Valid.

5. Navigate to Administration > Workspace > Subscription to confirm that your license has been applied correctly and your workspace plan is upgraded.

You may need to refresh your workspace for the changes to reflect. If you encounter an "Invalid key" error, upgrade your workspace to version 6.5 or higher and try again.

Apply license via deployment enviromental variable

If you have completed the Admin and Organization Information steps in the Rocket.Chat setup wizard, skip Step 3 (offline registration) and follow the instructions below to apply your license:

If you hashed your workspace URL, this is the only method to apply your workspace URL.

1. Open your compose.yml file and locate the rocketchat service. Under its environment section, add the following  deployment enviroment variables:

   OVERWRITE_SETTING_Show_Setup_Wizard: completed
   OVERWRITE_SETTING_Enterprise_License: <ENTER-YOUR-LICENSE-KEY>

   Replace <ENTER-YOUR-LICENSE-KEY> with license key you got from the Sales team.

   Setting OVERWRITE_SETTING_Show_Setup_Wizard: completed will skip workspace registration with the Rocket.Chat Cloud portal, which means your workspace won’t have access to cloud services like push notifications or Marketplace apps. The Workspace Info tab will also display the status as “Not registered”.

2. Restart your Rocket.Chat container to apply the changes:

   docker compose stop rocketchat
   docker compose rm rocketchat
   docker compose up -d rocketchat

3. Once the container is running, refresh your workspace URL in the browser. You’ll be redirected to the workspace home page.

4. Navigate to Administration > Workspace > Subscription to confirm that your license has been applied correctly and your workspace plan is upgraded.

Get a Starter license from Rocket.Chat cloud

The Starter plan license is the only license you can obtain directly from the Rocket.Chat Cloud portal. For Pro or Enterprise licenses, contact the Rocket.Chat Sales team.

Make sure that you have completed registering your workspace and continue with the following steps:

1. On your Rocket.Chat Cloud account, click on the workspace.

2. Click Get License.

3. Copy the license code provided and apply the license on your workspace.

If the workspace detects that is not airgapped it will still force you to register. The assumption is that the workspace is truly unable to communicate with the outside world.

Now that you've upgraded your workspace plan, you can explore the additional benefits Rocket.Chat offers on your workspace. In the next section, we'll show you some extra configurations you can make on your air-gapped workspace.