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

Chariot Installation on Linux

Summary​

This guide walks through installing the Chariot MQTT Server on a Linux system. Instructions are provided for both superuser and non-superuser installations, along with basic service management commands.

Prerequisites​

Before installing Chariot, ensure you have:

  • A Linux-based system (recommended: Ubuntu 22.04 LTS or newer)
  • The desired version of the Chariot MQTT Server .zip file downloaded (see Downloads)
  • Sufficient permissions to install and manage system services

⚠️ If upgrading from a previous version, review the upgrade documentation before proceeding.

Install Chariot (Superuser)​

  1. Transfer the Chariot .zip file to your Linux server
  2. Open a terminal and navigate to the directory containing the file
  3. Extract the archive:
    • unzip ./chariot_linux.zip -d ./Chariot
  4. Run the install script:
    • cd Chariot
    • /bin/bash ./install.sh

Chariot is now installed and configured to start automatically on system boot.

Install Chariot (Non-Superuser)​

  1. Transfer the Chariot .zip file to your server
  2. Create a dedicated user and grant temporary sudo access:
    • sudo adduser chariot
    • sudo usermod -aG sudo chariot
  3. Install required dependencies:
    • sudo apt-get install unzip
  4. Switch to the chariot user:
    • su chariot
  5. Extract the archive:
    • sudo unzip /tmp/chariot_linux.zip -d ./chariot
  6. Run the install script:
    • cd chariot
    • sudo /bin/bash ./install.sh
  7. Update ownership and remove elevated privileges:
    • cd ..
    • sudo chown -R chariot:chariot ./chariot
    • exit
    • sudo deluser chariot sudo
    • su chariot

Chariot is now installed and will start automatically on system boot.

Service Management​

Start the Service​

  • For Chariot versions prior to 2.4.1: /etc/init.d/chariot start
  • For Chariot versions 2.4.1 and newer: systemctl start chariot

Verify Service Status​

Run the command ./status.sh

  • Expected results:
    • RUNNING
    • INSTALLED
    • NOT INSTALLED

Access the Chariot Web UI​

  1. Open a browser and navigate to: http://<your-public-ip>:8080
  2. The Chariot Web UI (EULA page) should appear.
  3. Enter the default credentials:
    • Username: admin
    • Password: password

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

Other Service Commands​

Stop the Service​

  • For versions prior to 2.4.1: /etc/init.d/chariot stop
  • For versions 2.4.1 and newer: systemctl stop chariot

Restart the Service​

  • For versions prior to 2.4.1: /etc/init.d/chariot restart
  • For versions 2.4.1 and newer: systemctl restart chariot

Uninstall Chariot​

From the installation directory: ./uninstall.sh

🔍 Troubleshooting​

Installation Script Fails​
  • Ensure you have sufficient permissions (use sudo if needed)
  • Verify the .zip file was extracted successfully
  • Confirm required utilities (e.g., unzip) are installed
Service Will Not Start​

Verify the correct command is used for your version:

  • systemctl start chariot (v2.4.1+)
  • /etc/init.d/chariot start (older versions)

Check service status:

  • Run systemctl status chariot
Cannot Access Web UI​
  • Confirm the service is running
  • Verify port 8080 is open: sudo ufw allow 8080
  • Check firewall or network security settings
  • Ensure you are using the correct server IP: http://<your-server-ip>:8080
Permission Issues​
  • Avoid running the service with mixed user permissions
  • Ensure correct ownership of the installation directory: sudo chown -R chariot:chariot ./chariot