Versions Compared

Key

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

Prerequisites

  • Have a computer/server running Linux (recommended: Ubuntu 18.04 LTS or newer)
  • Download the required version of the Chariot MQTT Server zip file
Warning
If Upgrading Chariot to a Newer Version please review this tutorial.


The instructions below detail Installing (as superuser), Installing (as non superuser), Starting, Stopping, Restarting and Uninstalling the Chariot MQTT Server.


Anchor
install-chariot-linux-superuser
install-chariot-linux-superuser
Installing Chariot® MQTT Server (as superuser)

  1. Using the file transfer method of your choice, transfer the Chariot MQTT Server zip file to the Linux server. From a command prompt, run the unzip command on the file. For example, unzip the files into a directory named Chariot

    Code Block
    unzip ./chariot_linux.zip -d ./Chariot


  2. From the command prompt, run the Chariot service install script in the directory where the files were unzipped.

    Code Block
    /bin/bash ./install.sh



  3. The Chariot MQTT Server should now be installed in the Linux server and will run automatically when the server is booted.


Anchor
install-chariot-linux-non-superuser
install-chariot-linux-non-superuser
Installing Chariot MQTT Server (as non-superuser)


  1. Using the file transfer method of your choice, transfer the downloaded Chariot MQTT Server zip file to the server.

  2. From a command prompt, create a new user 'chariot' and give the user super user privileges

    Code Block
    languagebash
    sudo adduser chariot
    sudo usermod -aG sudo chariot


  3. From the command prompt, install the unzip utility.

    Code Block
    languagebash
    sudo apt-get install unzip


  4. From the command prompt, switch user to the 'chariot' user

    Code Block
    languagebash
    su chariot


  5. From the command prompt, run the unzip command on the file. For example, unzip the files into a directory named chariot

    Code Block
    languagebash
    sudo unzip /tmp/chariot_linux.zip -d ./chariot


  6. From the command prompt, run the Chariot service install script in the directory where the files were unzipped.

    Code Block
    languagebash
    cd chariot
    sudo /bin/bash ./install.sh


  7. From the command prompt, change ownership to 'chariot', log out of the 'chariot' user, remove 'chariot' from the sudo group and log in as 'chariot'

    Code Block
    languagebash
    cd ..
    sudo chown -R chariot:chariot ./chariot
    exit
    sudo deluser chariot sudo
    su chariot


  8. The Chariot MQTT Server should now be installed in the Linux server and will run automatically when the server is booted.




Anchor
Starting
Starting
Starting the Chariot MQTT Server

  1. From a command prompt, run the Chariot service start script in the directory where the service was installed.

    Code Block
    /etc/init.d/chariot start


  2. Verify the Chariot service is running. From a command prompt, run the Chariot service status script in the directory where the service was installed.

    Code Block
    ./status.sh

    The status returned will be: INSTALLED, NOT INSTALLED or RUNNING.

    Additionally the Chariot MQTT Server Web UI can be accessed on port 8080. Navigate to the server's URL in a browser and verify that the EULA page is shown.

Anchor
Stopping
Stopping
Stopping the Chariot MQTT Server

  1. From a command prompt, run the Chariot service stop script in the directory where the service was installed.

Code Block
/etc/init.d/chariot stop

Anchor
Restart
Restart
Restarting the Chariot MQTT Server

From a command prompt, run the Chariot service restart script in the directory where the service was installed


Code Block
/etc/init.d/chariot restart

Anchor
Uninstalling
Uninstalling
Uninstalling the Chariot MQTT Server

  1. From a command prompt, run the Chariot service uninstall script in the directory where the service was installed.

Code Block
./uninstall.sh