Get started with Coreflux

1. 1

   Run the installer in a Linux terminal

   Linux terminal (sh)

   curl -fsSL https://packages.coreflux.org/install.sh \| sudo sh -s -- --interactive

   Copy

   Choose 3 for Both to install MQTT Broker and Hub. Enter your sudo password if prompted.

   Supports Ubuntu 22.04 / 24.04, Debian 12 / 13 and RHEL-compatible 8 / 9 / 10. For both products on Ubuntu 26.04, use Docker Compose below.

2. 2

   Check that the broker is active (running)

   systemctl status coreflux-broker

   Copy
3. 3

   Open Hub and connect to your broker

   Open Coreflux Hub from your applications menu as your desktop user, without sudo. Click New Connection, choose mqtt://, set Host to localhost and Port to 1883. For a fresh install, enter username root and password coreflux, then click Connect. If you changed the credentials, use those instead.

Before you start, install Docker and make sure it is running. These commands work in PowerShell, macOS Terminal or a Linux shell.

1. 1

   Save the Compose file in an empty folder

   Download docker-compose.yml

   The file starts both services, keeps their data in named volumes and exposes their ports only on this computer. MQTT and WebSocket ports are included. TLS ports require configured certificates.

   View Compose file
2. 2

   Open a terminal in that folder and start both services

   PowerShell or terminal

   docker compose up -ddocker compose ps

   Copy

   Wait for both coreflux-broker and coreflux-hub to show as Up.

   Check that the broker responds

   curl --fail http://localhost:9100/health

   Copy

   If the broker is still starting, wait a moment and run the health check again.

3. 3

   Open Hub and connect to the broker

   Open Hub

   Hub is available at http://localhost:8080. Click New Connection, choose mqtt://, set Host to coreflux-broker and Port to 1883. For a fresh install, enter username root and password coreflux, then click Connect. If you changed the credentials, use those instead.

   Use coreflux-broker inside Hub because both services share the Compose network. From another MQTT client on your computer, use localhost:1883. For WebSocket connections, choose ws://, Host coreflux-broker, Port 5000 and Path mqtt.