Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fixed some typos, punctuation, and reworded in a few places

...

  • Name
    • A unique name for the Chariot Role.
  • Permissions
    • A list of permissions for the Chariot Role.

...

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

MQTT Credentials

Them MQTT Credentials are the credentials that clients will use to authenticate when establishing an MQTT connection to the Chariot MQTT Server.  The MQTT Credentials also contain the access control lists (ACLs) that control which MQTT topics a client can publish and/or subscribe on. Credentials can be added by clicking the "Add Credential" button, or they can be edited by clicking on the individual Credential in the table.

...

  • Username
    • A unique username that an MQTT client will use when connecting.
  • Password
    • A secure password that an MQTT client will use when connecting.
  • Publish Topics
    • A list of MQTT topic filters that the client is allowed to publish on (wildcards may be used).
  • Subscribe Topics
    • A list of MQTT topic filters that the client is allowed to publish subscribe on (wildcards may be used).

The "Add" button in the bottom right of the form can be clicked to create the Credential.

...

  • Enable Non-secure
    • Whether to enable non-secure client connections over plain TCP.
  • Non-secure Port
    • The port that the MQTT Server will listen on for non-secure connections.
  • Enable Secure
    • Whether to enable Secure client connections over SSL/TLS.
  • Secure Port
    • The port that the MQTT Server will listen on for secure connections.
  • Allow Anonymous
    • Whether to allow anonymous connections (no username and password).
  • Bind Address
    • The address that the MQTT Server will listen on for MQTT connections.

The "Update" button in the bottom right can be clicked to update the MQTT Server configuration once all changes have been made.  An update will restart the MQTT server.


License

The License Page page allows for adding, activating, and/or deactivating a Chariot License. A detailed tutorial for licensing Chariot can be found here Licensing Procedure.

...

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 form license text can be clicked to copy/past the license text directly inpasted directly into the form.

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.

...

Offline Activation requires the user to generating 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 and an Activation Request Code.
  • Deactivate and Generate Code
    • Deactivates an active Chariot License and generating generates a Deactivation Request Code.
  • Upload Activation Code
    • Uploads and an Activation Code that was obtained using the last generated Generate Activation Request Code.


System

The System page allows for the configuration of the Chariot MQTT Server's system settings as well as enabling secure (SSL/TLS) connections and uploading certificates.  A detailed tutorial for setting up SSL/TLS can be found here: Setting Up Securing Chariot MQTT Server with SSL/TLS

Configuration

The System page uses the following form to configure the system settings:

...

  • 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.

Certificates

The certificates tabs tab provides the means of uploading to upload the necessary certificates and keys for setting up SSL/TLS.

...

  • Private Key
    • An RSA private key in PEM format that was used to generate the certificate signing request for the server certificateCertificate.
  • CA ChainHTTP Port
    • An X.509 public root CA (Certificate Authority) certificate and any/all public intermediate CA certificates between the root and the CA that issued the certificate in PEM format. If there are no intermediate CAs, then the chain is made up of only the public root CA certificate.
  • CertificateEnable HTTPS
    • An X.509 server certificate in PEM format.

Once the three files are uploaded, the "Setup SSL" button can be clicked to finish the setup.

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

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

...