Skip to content

Getting started

Getting started

Follow the steps in order.

flowchart LR
Install["install"] -- "build" --> Start["first-start"]
Start -- "connect" --> Publish["first-publish"]
Publish -- "guard" --> User["first-user"]
User -- "view" --> Console["console"]

Before you start

  • Install the binaries with Install.
  • Keep ports 1883 and 18083 free.
  • Set these variables before the commands that need them:
Terminal window
# Example only: shows the variables that the tested commands use.
export API_KEY=your-api-key-here
export MQTT_PORT=1883
export API_PORT=18083

Check that it works

Each step ends with a check. Each check prints its expected output. The example test runs every check.

Next steps

  1. Install: get the binaries.
  2. First start: write the configuration and start the broker.
  3. First publish: subscribe and publish the first message.
  4. First user: create a user with a password.
  5. Console: open the dashboard.