Installation

Why Install Locally?

Running Coreflux on your own machine gives you a complete IoT data pipeline—MQTT broker, LoT runtime, and data routing—without external dependencies. Use the broker and Coreflux HUB from your browser.

Coreflux runs as a single binary or container. No databases, no message queues, no orchestration needed—just download and run.

Install Coreflux

Docker
Windows
Linux
Raspberry Pi

Docker is the fastest way to get Coreflux running. The official image works on Linux, macOS, and Windows. Pull the image from Docker Hub or open a terminal and run the command below—Docker will pull the latest image automatically.

docker run --pull=always -d --name coreflux_broker -p 1883:1883 -p 5000:5000 -p 8080:8080 -p 8443:8443 -v project-volume:/etc/project coreflux/coreflux-mqtt-broker:latest

The project-volume mount persists your broker project (LoT, routes, configuration) at /etc/project across container restarts. Docker creates the named volume on first run.

Port	Protocol	Description
`1883`	TCP	MQTT (unencrypted)
`5000`	WebSocket	WebSocket connections
`8080`	HTTP	Coreflux HUB (unencrypted)
`8443`	HTTPS	Coreflux HUB (TLS)

Open the HUB at http://localhost:8080 (or https://localhost:8443 with TLS) after the container starts.

New to Docker? Visit the official Docker documentation to learn more.

TLS/SSL Ports (when using certificates)

If you configure TLS certificates, expose these additional ports:

docker run --pull=always -d --name coreflux_broker -p 1883:1883 -p 5000:5000 -p 8080:8080 -p 8443:8443 -p 8883:8883 -p 443:443 -v project-volume:/etc/project coreflux/coreflux-mqtt-broker:latest

Port	Protocol	Description
`8883`	TCP/TLS	MQTT over TLS
`443`	WSS	WebSocket over TLS

See Broker Configuration for TLS setup.

Download and install Coreflux, then register it as a Windows service using the native sc tool.

Download the Windows zip from the Coreflux website
Extract the zip file to your preferred location (e.g., C:\Coreflux)
Open Command Prompt as Administrator and run:

sc create CorefluxBroker binPath= "C:\Coreflux\CorefluxMQTTBroker.exe" start= auto DisplayName= "Coreflux MQTT Broker"
sc description CorefluxBroker "Coreflux MQTT Broker Service"
sc start CorefluxBroker

The service is now registered, set to start automatically on boot, and running.

Manage the service

Use these native Windows commands to control the service:

sc stop CorefluxBroker
sc start CorefluxBroker
sc query CorefluxBroker

You can also manage it from Services (services.msc) in Windows.

Uninstall the service

Stop and remove the service with:

sc stop CorefluxBroker
sc delete CorefluxBroker

Download and run the Coreflux binary on Linux x64 systems.Quick Start (foreground):

Download the Linux zip from the Coreflux website (Start Free)
Extract and run (replace <downloaded-file> with your actual filename):

unzip <downloaded-file>.zip -d coreflux
cd coreflux
chmod +x CorefluxMQTTBroker
./CorefluxMQTTBroker

Production Setup (systemd service):

Create a service file:

sudo nano /etc/systemd/system/coreflux.service

Add this configuration (adjust paths as needed):

[Unit]
Description=Coreflux MQTT Broker
After=network.target

[Service]
Type=simple
User=root
WorkingDirectory=/opt/coreflux
ExecStart=/opt/coreflux/CorefluxMQTTBroker
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target

Enable and start the service:

sudo systemctl daemon-reload
sudo systemctl enable coreflux
sudo systemctl start coreflux

Check the status:

sudo systemctl status coreflux

Download and run the Coreflux binary on Raspberry Pi (64-bit ARM).Quick Start (foreground):

Download the Raspberry Pi zip from the Coreflux website
Extract and run (replace <downloaded-file> with your actual filename):

unzip <downloaded-file>.zip -d coreflux
cd coreflux
chmod +x CorefluxMQTTBroker
./CorefluxMQTTBroker

Production Setup (systemd service):

Create a service file:

sudo nano /etc/systemd/system/coreflux.service

Add this configuration:

[Unit]
Description=Coreflux MQTT Broker
After=network.target

[Service]
Type=simple
User=root
WorkingDirectory=/home/pi/coreflux
ExecStart=/home/pi/coreflux/CorefluxMQTTBroker
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target

Enable and start the service:

sudo systemctl daemon-reload
sudo systemctl enable coreflux
sudo systemctl start coreflux

Check the status:

sudo systemctl status coreflux

Enable the Coreflux HUB

The Coreflux HUB is available in two ways: via the Docker image (browser-based, requires port mapping) or as a standalone desktop application for Windows and Linux.

Docker
Standalone Desktop App

Map the HUB ports when you start the container to access the HUB from your browser:

Port	Protocol	Description
`8080`	HTTP	HUB (unencrypted)
`8443`	HTTPS	HUB (TLS)

docker run --pull=always -d --name coreflux_broker -p 1883:1883 -p 5000:5000 -p 8080:8080 -p 8443:8443 -v project-volume:/etc/project coreflux/coreflux-mqtt-broker:latest

The project-volume mount persists your broker project (LoT, routes, configuration) at /etc/project across container restarts. Docker creates the named volume on first run.

If the HUB ports are not mapped on Docker, the broker still runs normally—you simply won’t be able to open the HUB in the browser. See Coreflux HUB Overview for what you can do once it’s up.

Verify Installation

Confirm the broker is running—either in the Coreflux HUB (no extra tools) or with an MQTT client.

Coreflux HUB
MQTT Explorer

Open the HUB

For Docker, open http://localhost:8080 (or https://localhost:8443 with TLS).

Enter your credentials on the login page and click Connect to Coreflux.

Coreflux HUB login with username, password, and Connect to Coreflux — Coreflux HUB login page

Confirm the dashboard loaded

After a successful login, you should see the HUB home screen with the bottom navigation bar.

Coreflux HUB dashboard with Start here pointing to the first navigation icon — Coreflux HUB after login — start from the first icon in the navigation bar

The status bar shows route count and license info—the broker is reachable from the HUB.

Browse MQTT data

Select MQTT → Data Viewer. Expand $SYS/Coreflux in the Topic Tree—you should see broker topics such as Config, Version, and Resources updating live.

Coreflux HUB Data Viewer with Publish panel, Topic Tree, and tracked topic details — Data Viewer — Topic Tree, Publish panel, and live topic values

Open MQTT Explorer

Download MQTT Explorer or use any MQTT client of your choice.

Connect to the Broker

Create a new connection with these settings:

Setting	Value
Host	`localhost`
Port	`1883`
Username	`root`
Password	`coreflux`

Check System Topics

Subscribe to $SYS/# to see broker status messages. If you see topics such as $SYS/Coreflux/Version, the broker is running correctly.

You should see Coreflux system topics under $SYS/Coreflux/.

Next Steps

Getting Started

Create your first LoT Action in under 15 minutes.

VS Code Extension

Set up the LoT language extension for syntax highlighting.

Quick Start

Developing and Managing Coreflux

Coreflux MQTT Broker

LoT Language

Product Updates

Why Install Locally?

Install Coreflux

Enable the Coreflux HUB

Verify Installation

Next Steps

Getting Started

VS Code Extension

​Why Install Locally?

​Install Coreflux

​Enable the Coreflux HUB

​Verify Installation

​Next Steps

Getting Started

VS Code Extension

Why Install Locally?

Install Coreflux

Enable the Coreflux HUB

Verify Installation

Next Steps