Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page covers purchasing a Chariot license and activating it on a Chariot MQTT Server with internet access. It also covers upgrading an existing license, applying license updates with reactivation, and deactivating a license before decommissioning a server.

For air-gapped deployments, see Offline licenses. For multi-instance deployments inside a closed network, see Self-Hosted Floating License Server.


Note
There are no additional licensing steps for Chariot instances deployed

The Chariot® MQTT Server Web UI allows for uploading, activating, and deactivating valid Chariot Licenses.

Note
If you have deployed Chariot through AWS Marketplace or Azure Marketplace , then no additional steps are required - your license is - licenses are already installed and activated.

This tutorial will cover the process for both online and offline activations and deactivations:

Online activation

Online deactivation

Offline activation

Offline deactivation

Prerequisites

Purchase a New License

There are two ways to purchase a Chariot license:

  • Through the Chariot UI (covered below) — self-serve via Stripe
    • Single instance Node-Locked Online Licenses Only
  • By contacting Cirrus Link Support
    • All Licensing Models


The instructions below cover the Chariot UI flow.

In the Chariot UI, navigate to the License page.

Image Added


Select I need to purchase a license from the wizard. A modal opens showing the features available for purchase:

    • IoT Bridge for Snowflake — Connect Chariot to Snowflake (meter-based licensing)
    • MQTT Server — Full-featured MQTT server (one-time purchase)
    • MQTT Server Support — A year of support (can be purchased yearly or multiple years at once)

Image Added


Select desired features and click Purchase. The page will redirect to the Stripe purchase page.


Image Added


Verify that the product selection matches what was selected in Chariot.


Image Added




Fill out the payment information and click Pay. If the payment was successful, the page will redirect back to Chariot.


Image Added


Cirrus Link will generate the requested license and email it to the provided contact email.  Be aware this can take up to 24 hours. 

Activate a License Online

After receiving the license key by email, activate it on a Chariot MQTT Server.

The Chariot License page wizard offers three activation methods; Online, Offline, and Floating, which correspond to the three license deployment models.


Image Added

Info
titleLicence Deployment Models
  • Online - Requires an external internet connection and Chariot license key
  • Offline - No external internet, will require email communication with Cirrus Link providing generated codes to gain the appropriate access
  • Floating - A self hosted license server that serves available licenses as requested 


This section covers Online; for the other two, see Offline Licenses or Self-Hosted Floating License Server

...

The Online Activation feature allows a Chariot License to be automatically activated on a Chariot MQTT Server instance that is connected to the internet.  The Chariot MQTT Server will remotely connect and activate a Chariot License if it is valid and has an activation available.

Log into the Chariot MQTT Server Web UI and from the left hand menu bar select License as shown below:

Image Removed

Image Added


Follow the wizard selecting first the license activation method type (Online)


Image Added

Provide the The text file containing the Chariot License can either be dragged/dropped in the "Upload License" area, or the area can be clicked to bring up an empty form and the license text can be copied/pasted into the form.  A successfully added license will look like the following:

Image Removed

Click the OK button to finish uploading the Chariot License. The license will auto activate and the page should look like the following. The Chariot MQTT Server is now fully Licensed and read to you.

Image Removed

the Chariot License Key. Drag and drop the file, paste the key directly, or click the upload button and select the file.


Image Added

Image Added

Confirm to finish the wizard.


Image Added

A successful activation will show the license status page, showing the state of the license, activated features, and related details.

Image Added

Upgrade an Existing License

Add features to an existing license — for example, adding IoT Bridge for Snowflake to an MQTT Server license, or adding additional years of support — without re-purchasing the original features.

There are two ways to upgrade a license:

  • Through the Chariot UI (covered below) — self-serve via Stripe
  • By contacting Cirrus Link Support — for enterprise deals, custom terms, or payment via purchase order or invoice

The instructions below cover the Chariot UI flow.

  1. In the Chariot UI, navigate to the License page.
  2. Locate the Upgrade License widget and click Upgrade License.
  3. Select the features to add to the existing license.
  4. Click Purchase. Chariot will redirect to the Stripe purchase page.
  5. Verify two things on the Stripe page:
    • Product selection matches what was selected in Chariot
    • The license key field is pre-populated with the existing Chariot License key
  6. Fill out the payment details and click Pay. Do not change the license key.
  7. If the payment was successful, the page will redirect back to Chariot.

Cirrus Link will upgrade the license and email confirmation to the contact email on file. This can take up to 24 hours. After receiving confirmation, click Reactivate on the License page (see below) to apply the new features.

Features already activated on the license will not appear in the upgrade options, with one exception: MQTT Server Support can be purchased at any time to add additional years of support.

Reactivate an Online License

If a license has been updated — feature change, expiration date change, or any other update — click Reactivate on the License page to pull the updates without restarting Chariot.

Image Added

Image Added


Warning
This will not work with offline activated licenses. Contact Cirrus Link Support for any changes.

Deactivate an Online License

...

In order to deactivate the license online, log into the Chariot MQTT Server Web UI and from the left hand menu bar select License as shown below.

Image Added


Image RemovedImage Added


Select "Deactivate License" for the license to be remotely deactivated so that it can be potentially activated on another Chariot MQTT Server instance.

...

Warning
If the server is terminated, deleted, or destroyed without deactivating the active Chariot License, that license will permanently lose one of its total number of activations

...


Once deactivation is successfully completed, the page will show the license activation wizard


Image Added 

What if I forgot to deactivate?

If a Chariot server was destroyed without deactivating first and you are unable to activate the license elsewhere, contact Cirrus Link Support. Include the License ID and a brief description of what happened. Support can review the situation and, in many cases, restore the lost activation.

Related Pages

...

For Chariot MQTT Server instances that do not have internet access, an offline action process is available.

Log into the Chariot MQTT Server Web UI and from the left hand menu bar select License as shown below:

Image Removed

Click on the "Online Activation" toggle to change it to "Offline Activation" mode, as shown below.

Image Removed

The text file containing the Chariot License can either be dragged/dropped in the "Upload License" area, or the area can be clicked to bring up an empty form and the license text can be copied/pasted into the form.  A successfully added license will look like the following:

Image Removed

Click the OK button to finish uploading the Chariot License.  The license will NOT activate and the page should look like the following:

Image Removed

Now click the "Generate Activation Request" to generate a new request. 

Warning
Only do this ONCE as each new Activation Request will invalidate the previous one.

Image Removed

Tip
Copy/paste the generated code to a text file and send the file to Cirrus Link Support along with the License ID in order to obtain an Activation Code.

Once the Activation Code is obtained return to the License page in the Chariot MQTT Server Web UI and click on "Upload Activation Code" and copy/paste the Activation Code into the form.

Image Removed

Click OK and the license should be successfully activated.

...

In order to deactivate the license offline, log into the Chariot MQTT Server Web UI and from the left hand menu bar select License. Ensure that "Offline Activation" is toggled as shown below:

Image Removed

Select the "Deactivate and Generate Request". 

Tip
This will provide a Deactivation Request code that should be provided to Cirrus Link Support along with the License ID in order to free up the previous activation for use with another Chariot MQTT Server instance.

...