Installation Guide

docker pull hivemq/hivemq-ce:latest

docker pull hivemq/hivemq-ce:2025.5

docker run --name hivemq-ce -d -p 1883:1883 hivemq/hivemq-ce

docker run -d \
  --name hivemq-ce \
  -p 1883:1883 \
  -p 8000:8000 \
  -v /path/to/conf:/opt/hivemq/conf \
  -v /path/to/data:/opt/hivemq/data \
  -v /path/to/extensions:/opt/hivemq/extensions \
  -e HIVEMQ_LOG_LEVEL=INFO \
  hivemq/hivemq-ce

git clone https://github.com/hivemq/hivemq-community-edition.git
cd hivemq-community-edition

./gradlew hivemqZip

./gradlew loadOciImage

./gradlew check

<dependency>
    <groupId>com.hivemq</groupId>
    <artifactId>hivemq-community-edition-embedded</artifactId>
    <version>2025.5</version>
</dependency>

implementation 'com.hivemq:hivemq-community-edition-embedded:2025.5'

import com.hivemq.embedded.EmbeddedHiveMQ;
import java.nio.file.Path;

public class EmbeddedExample {

    public static void main(String[] args) {
        final EmbeddedHiveMQ hivemq = EmbeddedHiveMQ.builder()
            .withConfigurationFolder(Path.of("/path/to/config"))
            .withDataFolder(Path.of("/path/to/data"))
            .withExtensionsFolder(Path.of("/path/to/extensions"))
            .build();

        try {
            hivemq.start().join();
            System.out.println("HiveMQ CE started successfully!");
            
            // Your application logic here
            
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            hivemq.stop().join();
        }
    }
}

import com.hivemq.embedded.EmbeddedHiveMQ;

public class EmbeddedExample {

    public static void main(String[] args) {
        try (final EmbeddedHiveMQ hivemq = EmbeddedHiveMQ.builder().build()) {
            hivemq.start().join();
            
            // Your application logic
            
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
}

import com.hivemq.embedded.EmbeddedExtension;
import com.hivemq.extension.sdk.api.ExtensionMain;
import com.hivemq.extension.sdk.api.parameter.*;

final EmbeddedExtension extension = EmbeddedExtension.builder()
    .withId("my-extension")
    .withName("My Custom Extension")
    .withVersion("1.0.0")
    .withPriority(0)
    .withStartPriority(1000)
    .withAuthor("Your Name")
    .withExtensionMain(new MyExtensionMain())
    .build();

final EmbeddedHiveMQ hivemq = EmbeddedHiveMQ.builder()
    .withEmbeddedExtension(extension)
    .build();