Versions Compared

Key

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

...

Clicking on the edit icon on a Chariot User in the table will display a modal form for editing the Chariot User.

Image Modified

Image Modified


Leaving the password empty will retain the existing users password.

...

The Roles page allows for the creating, updating, and deleting of Chariot Roles.  A Chariot Role is a collection of permissions that authorized viewing, editing, and/or controlling the Chariot MQTT Server. The main Chariot Roles page shows a table of existing Chariot Roles.  Roles can be added by clicking the "Add Role" button, or they can be edited by clicking on the individual Role in the table.


Image Modified

Add Role

Clicking the "Add Role" button will display a modal form for creating a new Chariot Role.

Image Modified

The form contains the following fields:

...

Clicking on the edit icon on a Chariot Role in the table will display a modal form for editing the Chariot Role.

Image Modified

The "Update" button in the bottom right can be clicked to update the Chariot Role once all changes have been made.

...

Tip

This feature is available in Chariot v2.4.2 and newer

Review the LDAP and Microsoft Active Directory for Chariot UI/REST Users for configuration details

Image Modified

Anchor
MQTT Accounts
MQTT Accounts

...

Tip

From Chariot release 2.5.0, to avoid manual configuration, the required ACLs can be generated from the Main Navigation > Sparkplug > Tools menu and will automatically be added to the MQTT Credentials

 

Image Modified

Add Credential

Clicking the "Add Credential" button will display a modal form for creating a new MQTT Credential.

Image Modified

The form contains the following fields:

...

Examples of MQTT Credentials

Image Modified

Edit Credential

Clicking on the edit icon on a MQTT Credential in the table will display a modal form for editing the Credential.

Image Modified

Image Modified

The "Save" button in the bottom right can be clicked to update the Credential once all changes have been made.

...

Tip

This feature is available in Chariot v2.4.2 and newer

Review the LDAP for MQTT Clients for configuration details

Image Modified

Anchor
MQTT Server Configuration
MQTT Server Configuration

...

The configuration tab is a simple form used to configure the MQTT Server.

Image Modified

The form contains the following fields:

...

Note
Bridging is supported in release 2.3.0 forward


Image Modified

To edit an existing bridge client, select the client from the UI. To add a new bridge client , select Add Bridge Client.

Image Modified

Image Modified

The form contains the following fields:

...

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

Image Modified

Upload License

A Chariot License is represented by a text file which contains a license key.  The file can either be dragged/dropped into the "Upload License" form, or the license text can be pasted directly into the form.

Image Modified

Tip
The Activate toggle (in the Upload License form) can be used to auto-activate the license immediately after it is uploaded. This is a convenience to prevent the need to click Activate License after uploading a license.

...

Online Activation allows the Chariot MQTT Server to remotely connect to the Chariot Licensing server for activation and deactivation of Chariot Licenses. When the "Online Activation" is selected, the License page appears with the following options:

Image Modified

  • Activate License
    • Activates an uploaded Chariot License by remotely accessing the Chariot Licensing Server.
  • Deactivate License
    • Deactivates an uploaded & active Chariot License by remotely accessing the Chariot Licensing Server.

...

Offline Activation requires the user to generate an activation request and provide it to Cirrus Link Solutions in order to obtain an Activation Code.  The Activation Code can then be uploaded into the Chariot MQTT Server to activate the previously uploaded Chariot License.  When the "Offline Activation" option is selected, the License page appears with the following options:

Image Modified

  • Generate Activation Code
    • Generates an Activation Request Code.
  • Deactivate and Generate Code
    • Deactivates an active Chariot License and generates a Deactivation Request Code.
  • Upload Activation Code
    • Uploads an Activation Code that was obtained using the Generate Activation Code.

...

The Web Server page uses the following form to configure the web server settings:

Image Modified

The form contains the following fields:

...

Warning
Self-signed certificates should not be used in a production environment on a public network.


Image Modified

The Certificates page contains the following fields:

...

If successful, the certificate information will now be displayed on the Certificates page:

Image Modified

The "Delete Certificates" button can be used to remove the certificate and key from the Chariot MQTT Server and revert to a "SSL Not Setup" state.

...

This page allows for the backup and restore of Chariot configuration data.

Image Modified

  • Export Backup
    • This button downloads a backup.zip file that contains the current configuration data of the Chariot instance
  • Restore From Backup
    • This button restore configuration data from backup.zip file.

...