Skip to main content

​
Why Use Fleet?

Fleet lists every broker in your organization in one table — where it runs, whether it is online, which version it runs, and which license it uses. You add brokers here, and open any broker to see its performance.
Coreflux Portal Fleet table listing brokers with their address, status, hosting, alerts, CPU, and throughputCoreflux Portal Fleet table listing brokers with their address, status, hosting, alerts, CPU, and throughput

Fleet with brokers in different states

​
Add a Broker

Click Add broker in Fleet. The first question is Where will it run?
Coreflux Portal Add broker dialog asking Where will it run, with options to install on a computer you manage, connect a running broker, or use Coreflux CloudCoreflux Portal Add broker dialog asking Where will it run, with options to install on a computer you manage, connect a running broker, or use Coreflux Cloud

Add broker: Where will it run?

Adding a license to a broker needs a license with a free place. If your organization has none yet, the Portal asks you to get a license first — start a trial or claim one in Licensing.

​
Install a New Broker

The Portal shows the commands for your platform — docker run, a Linux service, the Windows installer, or helm install — with your activation code already filled in. The broker starts with COREFLUX_ACTIVATION_CODE, activates its license, and joins your Fleet on its own.
The activation code is shown once. The Portal keeps only a hash of it. Later views of the install command show a placeholder instead; replace it with your code, or get a new one from the license page.
Keep the broker’s data volume (mounted at /etc/project in Docker) persistent. The broker stores its identity there. Without it, every restart counts as a new install and uses another license place.

​
Connect a Running Broker

For a broker that is already running, choose I already have a broker running, pick the license, and click Get activation command. The Portal shows the activation code and the command to publish to $SYS/Coreflux/Command. The broker picks up your license and joins your Fleet. The code is shown once and is valid for 20 minutes. See Licensing and Enrollment for the broker side.
Animation of the Add broker dialog: choosing I already have a broker running, picking a license, and getting the activation commandAnimation of the Add broker dialog: choosing I already have a broker running, picking a license, and getting the activation command

Connect a running broker and get its activation command

Coreflux Portal Activate the broker dialog with a redacted activation code and the -activateLicense command for $SYS/Coreflux/CommandCoreflux Portal Activate the broker dialog with a redacted activation code and the -activateLicense command for $SYS/Coreflux/Command

The activation command, shown once

To add a broker without a license, choose Add to Fleet without a licence. Name the broker, and the Portal creates a one-time connection code for it, with the -enroll command to publish to $SYS/Coreflux/Command. The code is shown once, works once, and is valid for 20 minutes. You can activate a license on that broker later.
Animation of the Add broker dialog: choosing Add to Fleet without a licence, naming the broker, and getting a one-time connection codeAnimation of the Add broker dialog: choosing Add to Fleet without a licence, naming the broker, and getting a one-time connection code

Add a broker without a license and get a one-time connection code

Coreflux Portal One-time connection code dialog with a redacted code and the -enroll command for $SYS/Coreflux/CommandCoreflux Portal One-time connection code dialog with a redacted code and the -enroll command for $SYS/Coreflux/Command

The one-time connection code, shown once

​
Deploy in Coreflux Cloud

Choose In Coreflux Cloud to have Coreflux run the broker. The Portal starts the deployment and shows its progress in Fleet (Deploying, or Deploy failed with the reason). Only admins and owners can deploy to Cloud.

​
Broker Status

Use Filter brokers and the column headers to find a broker in a long list.

​
Broker Details

Open a broker to see its address, version, license, and last seen time, plus performance: messages, peak throughput, error rate, time seen online, and charts of messages per second, data, and connected clients. Pick the range with 1h, 24h, 7d, or 30d. Enrolled brokers’ performance metrics are charted on this page.
Coreflux Portal broker page with the broker's status, version, and license, and charts of throughput and resource useCoreflux Portal broker page with the broker's status, version, and license, and charts of throughput and resource use

Broker details with performance charts

Performance charts need the broker to send telemetry. A broker that has not been activated shows Available once this broker is activated.

​
Troubleshooting

The broker reports why on $SYS/Coreflux/License, under Enrollment.Reason. Common causes:
  • The broker started without an activation code, so it runs the free edition.
  • The broker cannot reach the platform on port 443. Allow it through your firewall or proxy; the broker retries on its own.
  • The license is not claimed by an organization. Start a trial or claim the license in Licensing, then restart the broker.
Until it joins, the broker keeps working for local users.
An activation code needs the license service online. Offline sites use a signed license file instead; ask Coreflux support for one. A broker licensed this way does not appear in Fleet.
The data volume was lost, so the broker started as a new install. On the license page in Licensing, free up the old broker’s place, and keep the volume persistent from then on.
One-time connection codes work once and are valid for 20 minutes. Get a new code from the broker in Fleet and use it straight away.
Last modified on October 21, 2026