Page History
...
| Anchor | ||||
|---|---|---|---|---|
|
...
Clicking the "Add User" button will display a modal form for creating a new Chariot User.
...
Clicking the "Add Role" button will display a modal form for creating a new Chariot Role.
...
Clicking the "Add Credential" button will display a modal form for creating a new MQTT Credential.
...
| Tip |
|---|
This feature is available in Chariot v2.4.2 and newer Review the LDAP for MQTT Clients for configuration details |
| Anchor | ||||
|---|---|---|---|---|
|
...
The configuration tab is a simple form used to configure the MQTT Server.
The form contains the following fields:
...
| Note |
|---|
| Bridging is supported in release 2.3.0 forward |
To edit an existing bridge client, select the client from the UI. To add a new bridge client , select Add Bridge Client.
The form contains the following fields:
...
- Client ID
- The MQTT client ID to use for connecting to the server.
- Keep Alive
- The MQTT keep alive time in seconds.
- Clean Session
- Whether to connect with a clean session.
- Allow Retained
- Whether the retained message flag is allowed on messages published to the server.
- Try Private
- Whether the client should attempt to indicate to the server that it is a bridge client.
- This feature helps to detect message loopback, but is only supported by some MQTT servers and may need to be disabled in order to connect.
- Sub Topics
- The topics filters that will be subscribed on by the bridge client.
- The topic filters are of the form <topic>:<qos> or just <topic>.
- Pub Topics
- The topics filters that will be published on by the bridge client. These are used to restrict/filter which messages (flowing through Chariot) are published to the remote server,
- The topic filters are of the form <topic>:<qos> or just <topic>.
The "UpdateSave" button in the bottom right can be clicked to update the MQTT Server Bridging configuration once all changes have been made
...
| 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. |
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.
| 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:
- 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:
- 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.
| Anchor |
|---|
...
|
...
|
...
Web Server
The System Web Server page allows for the configuration of the Chariot MQTT Server's system settings as well as enabling secure (SSL/TLS) connections and uploading certificates.
| Tip |
|---|
| A detailed tutorial for setting up SSL/TLS can be found here: Securing Chariot® MQTT Server. |
It comprises three tabs: Configuration, Certificates and Backup/Restore
...
uses the following form to configure the web server settings:
...
The System page uses the following form to configure the system settings:
The form contains the following fields:
- Server Name
- An optional name for this Chariot installation.
- Enable HTTP
- Whether to enable non-secure HTTP connections to the Chariot Web UI.
- HTTP Port
- The port that the Chariot MQTT Server will use for HTTP.
- Enable HTTPS
- Whether to enable Secure HTTPS connections to the Chariot Web UI.
- HTTPS Port
- The port that the Chariot MQTT Server will use for HTTPS.
| Anchor |
|---|
...
|
...
|
The certificates tab page provides the means to upload the necessary certificates and keys for setting up SSL/TLS.
| Tip |
|---|
| A detailed tutorial for setting up SSL/TLS can be found here: Securing Chariot® MQTT Server. |
| Warning |
|---|
| Self-signed certificates should not be used in a production environment on a public network. |
The Certificates tab page contains the following fields:
...
If successful, the certificate information will now be displayed on the Certificates tabpage:
The "Delete SSLCertificates" button can be used to remove the certificate and key from the Chariot MQTT Server and revert to a "SSL Not Setup" state.
| Anchor |
|---|
...
|
...
|
This tab page allows for the backup and restore of Chariot configuration data.
- 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.
...
Overview
Content Tools