Skip to content

Getting Started with Coreflux

Welcome to Coreflux! This guide will help you choose the right path based on your needs and preferences.

Installation Options

First, choose how you want to install Coreflux:

  • Docker Installation

    Quick and easy setup using Docker or Docker Compose. Perfect for development, testing, and containerized deployments.

    Install with Docker

  • Native Installation - Hub

    Install Coreflux Hub with full UI capabilities for production environments with visual management needs.

    Install Hub

  • Native Installation - Hubless

    Lightweight broker-only installation for edge devices, embedded systems, and command-line workflows.

    Install Hubless

Choose Your Experience

After installation, Coreflux offers three distinct experiences to match your preferred workflow and use case:

  • MQTT Command Experience

    A command-driven approach for direct control over your MQTT broker, ideal for developers who prefer granular configuration and scripting.

    Get Started with MQTT Command

  • Hub Experience

    A visual, UI-based approach for managing your MQTT broker, assets, and configurations through an intuitive interface.

    Get Started with Hub

  • System as Code Experience

    Create complete, self-documenting IoT systems using LOT Notebooks that combine code and documentation in a single file.

    Get Started with System as Code

Prerequisites

Before starting with any experience, please ensure you have:

  • Basic Understanding of MQTT: Publish/Subscribe model, Broker concept, QoS levels
  • Hardware: At least 2GB RAM and 500MB disk space
  • Network: Open ports 1883 (MQTT) and 8883 (MQTT over TLS)
  • Familiarity with JSON: For configuration files

For more detailed prerequisites, see our Technical Requirements page.