Skip to main content
Chariot v2.0.0 - v2.6.0

Chariot Installation via AWS Marketplace

Summary​

This guide walks through deploying the Chariot MQTT Server from the Amazon Web Services (AWS) Marketplace using a CloudFormation template. When deployed through the Marketplace, the Chariot license is automatically installed and activated.

⚠️ Currently, installations via Marketplace are only available for Chariot's most recent stable version. To install and utilize earlier versions of Chariot, please see either Linux or Windows installation instructions on the navigation bar to the left.

Prerequisites​

Before deploying Chariot, ensure you have:

  • An active AWS account
  • An EC2 key pair created in your target region (used for SSH access)

⚠️ The key pair must exist in the same region where you deploy Chariot.

Deploy Chariot from AWS Marketplace​

  1. Navigate to the AWS Marketplace and sign in.
  2. In the search bar, enter: Chariot MQTT Server
  3. Select Chariot MQTT Server by Cirrus Link
  4. Click Continue to Subscribe
  5. Accept the terms by clicking Accept Terms
  6. Wait for the subscription to activate
  7. Click Continue to Configuration

Configure the Deployment​

  1. Under Fulfillment option, select: CloudFormation Template
  2. Choose your preferred:
    • Region
    • Version (if applicable)
    • Click Continue to Launch

Launch the CloudFormation Stack​

  1. Click Launch
  2. On the CloudFormation page, click Next

Stack Configuration​

Set the following required parameters:

  • Stack Name: A friendly name to identify your deployment
  • Instance Type: Determines performance and cost
  • KeyName: Select the EC2 key pair created earlier
  • SSH Location: IP range allowed to SSH into the instance
    • Example (open): 0.0.0.0/0 (not recommended for production)
    • Example (restricted): your-ip/32
  • Chariot UI Location: IP range allowed to access the web UI
    • Same guidance as SSH location

Click Next to continue.

Review and Create​

  1. Configure any optional settings (defaults are usually sufficient)
  2. Ensure Roll back all stack resources is enabled
  3. Click Next, then Submit

Monitor Deployment​

  • Status will show: CREATE_IN_PROGRESS
  • Use the Events and Resources tabs to track progress
  • Deployment typically completes within a few minutes

When complete, all resources should show: CREATE_COMPLETE

🔍 Troubleshooting Deployment Failures​

If deployment fails:

  • Open the Events tab
  • Review the Status reason column
  • Delete the failed stack
  • Resolve the issue (commonly AWS resource limits)
  • Retry deployment

Connect to Your Chariot Instance​

Access the Web UI

  1. Open a browser and navigate to: http://<your-instance-ip>:8080
  2. Log in using:
  • Username: admin
  • Password: your EC2 instance ID
    • Example: i-0049ac1e13e558b70

⚠️ It is strongly recommended to change the admin password after first login.

Connect via SSH​

Use the EC2 key pair you created earlier:

ssh -i /path/to/your-key.pem ec2-user@<your-instance-ip>

🔍 Troubleshooting​

Cannot Access Web UI​
  • Verify your security group allows port 8080
  • Confirm the instance is running
SSH Connection Issues​
  • Verify correct key pair is used
  • Confirm port 22 is open to your IP
Deployment Fails​
  • Check CloudFormation Events
  • Look for resource limit errors
  • Retry after resolving issues