HiveMQ Documentation HiveMQ Documentation
Get HiveMQ
Home
HiveMQ Platform
Getting Started HiveMQ Control Center HiveMQ Extension Developer Guide HiveMQ REST API HiveMQ Upgrade Guides
HiveMQ Enterprise Extensions
HiveMQ Enterprise Bridge Extension HiveMQ Enterprise Data Lake Extension HiveMQ Enterprise Distributed Tracing Extension HiveMQ Enterprise Extension for Amazon Kinesis HiveMQ Enterprise Extension for Google Cloud Pub/Sub HiveMQ Enterprise Extension for Kafka HiveMQ Enterprise Extension for Microsoft SQL Server HiveMQ Enterprise Extension for MongoDB HiveMQ Enterprise Extension for MySQL HiveMQ Enterprise Extension for PostgreSQL HiveMQ Enterprise Extension for Snowflake HiveMQ Enterprise Security Extension
HiveMQ Cloud HiveMQ Edge HiveMQ Data Hub HiveMQ Platform Operator HiveMQ Swarm

Version:

latest 4.28 4.9 4.5 3.4
  • HiveMQ Platform
    • Getting Started with HiveMQ
      • HiveMQ Editions
      • Select a Way to Run HiveMQ
        • HiveMQ Cloud SaaS
        • ZIP Download Package
        • Run on Docker
        • Deploy on AWS
        • Deploy on Azure
        • Deploy on Kubernetes
    • MQTT Compliance
      • Supported MQTT Versions
      • Supported MQTT Features
      • Additional Features
    • System Requirements
      • Supported Operating Systems
      • Minimum Hardware Requirements
      • Environment
      • Linux Configuration Optimizations
    • Installation
      • Directory Structure
      • Linux
      • Windows
      • License
      • Sanity Checks
        • Open File Limit Test
        • System Access Permissions Test
      • Cloud Service Providers
        • Amazon Web Services (AWS)
          • AWS EC2
          • AWS EC2 Cluster
          • Elastic Kubernetes Service (EKS)
        • Microsoft Azure
          • ARM Template
          • Azure Kubernetes Service (AKS)
    • General Configuration Information
      • Configuration Files
      • Default Configuration
      • Configuration Validation
        • Change Configuration Validation
      • Environment Variables
      • Custom HiveMQ Folders
      • HiveMQ with IPv6
        • Adjust Configuration
        • Available Listeners
        • Cluster Discovery
        • Special-use Addresses
    • MQTT-Specific Configuration Options
      • Session and Message Expiry
      • Maximum Packet Size
      • Server Receive Maximum
      • Maximum Keep Alive
      • Allow Unlimited Keep Alive
      • Topic Alias
      • Subscription Identifier
      • Wildcard Subscriptions
      • Shared Subscriptions
      • Maximum QoS
      • Retained Messages
      • Queued Messages
      • Security Configuration Options
        • Allow Empty Client ID
        • PUBLISH Payload Validation
        • UTF-8 Validation
        • Request Problem Information
        • Example Security Configuration
    • MQTT Add-ons
      • Topic Add-ons
        • Expired Messages Topic
          • Configuration
          • User Properties
          • Additional Metrics
        • Dropped Messages Topic
          • Configuration
          • User Properties
          • Additional Metrics
        • Dead Messages Topic
          • Configuration
          • User Properties
          • Additional Metrics
      • Use Cases
        • Expired Messages Topic
        • Dropped Messages Topic
        • Dead Messages Topic
    • Backup & Restore
      • Back Up with the HiveMQ Control Center
      • Back Up with the HiveMQ REST API
      • Backup Export File Content
      • Backup File Location
      • Create a Backup
        • Export Requirements
      • Restore from a Backup
    • Listeners
      • Multiple Listeners
      • TCP Listener
        • Secure TCP Listener
          • Cipher Suite Preference
      • WebSockets
        • Native WebSocket Listener
        • Secure WebSocket Listener
    • HiveMQ Cluster
      • Enable Cluster
      • Cluster Discovery
        • Static Discovery
        • Multicast Discovery
        • Broadcast Discovery
        • Extension Discovery
      • Cluster Transport
        • TCP Transport
        • UDP Transport
        • Secure TCP Transport with TLS
      • Failure Detection
        • Heartbeat
        • TCP Health Check
      • Replication
      • Rolling Upgrades
      • Cluster Disaster Recovery
        • Disaster Detection
        • Live Backup Import
        • Recovery Tool
        • Recovery Quick Start
      • Cluster Restart with Persistent Data
    • Security
      • Authentication & Authorization
      • TLS
      • Java Key- and Trust Store
      • Communication Protocol
      • Cipher Suites
      • Native SSL
      • Randomness
      • OCSP
      • Audit Log
    • Logging
      • Logging Levels
      • Event Log
      • Machine-Readable Log Files
        • JSON Logging
      • Extension Log Files
      • Syslog
    • Health API
      • Configuration
      • HTTP Responses
      • Health Monitoring
        • Kubernetes Probes
        • HAProxy
      • System Health
      • Health Components
        • Info
        • Cluster
        • MQTT
        • Control Center
        • REST API
      • Extensions
      • Health Groups
        • Liveness Check
        • Readiness Check
    • Monitoring
      • JMX
      • Prometheus
      • InfluxDB
      • HiveMQ Metrics
        • Metric Types
        • Standard HiveMQ Metrics
        • System and OS Metrics
        • JVM Metrics
        • HiveMQ Cluster Metrics
        • HiveMQ Health Metrics
        • HiveMQ REST API Metrics
    • PROXY Protocol
      • Configuration
      • Custom TLVs
    • Load Balancers
      • Offload SSL/TLS Termination
      • Proxy Protocol
      • Idle Timeout
      • Decrease Cluster Size
    • Restrictions
      • Connection Limits
      • Throttle Connection Rates
      • Throttle SSL Handshakes
      • Throttle Bandwidth
      • Connection Timeouts
      • MQTT Client ID Length Limits
      • MQTT Topic Length Limits
    • Cluster Overload Protection
      • Configuration
      • Monitoring
    • Client Event History
      • Configuration
      • Monitoring
    • Shared Subscriptions
      • Topic Structure
      • Concepts
      • Use Cases
      • QoS Levels
    • Declared Shared Subscriptions
      • Configuration
      • Concepts
      • Use Cases
    • Diagnostic Mode
      • Enabling Diagnostic Mode
      • Sending diagnostic file to the HiveMQ Support Team
    • Troubleshooting
      • Port Assignment
      • Port Already in Use
      • Slow HiveMQ Startup
      • Time Synchronization
    • How-Tos
      • Server Side TLS
      • TLS with Portecle
      • TLS with Client Certificates
    • HiveMQ and Docker
      • HiveMQ Docker Hub Repository
      • Tags
      • HiveMQ DNS Discovery Docker Image
        • HiveMQ Cluster on Docker Swarm
        • HiveMQ Cluster on Kubernetes
      • Add a HiveMQ License
      • Access the HiveMQ Control Center
      • Override the Bind Address
      • HiveMQ Base Docker Image
        • HiveMQ Single Node in Docker
      • Custom HiveMQ Docker Image
    • HiveMQ Knowledge Base Articles
  • HiveMQ Control Center
    • Introduction
    • Getting Started
      • Enabling the Control Center
      • Accessing the Control Center
    • Configuration
      • Access Control
      • User Configuration
      • Generating SHA256 Passwords
      • Role Based Access Control
      • Control Center Listener
        • HTTP-Listener
        • HTTPS-Listener
      • Client Event History
      • Control Center behind a Load Balancer
    • Available Information
      • Overview
    • Dashboard
      • Notifications
      • Active License
      • Cluster Node Statistics
    • Clients View
      • Details
        • Session
        • Connection
        • TLS
        • Last Will
        • Restrictions
        • Proxy Protocol
        • Subscriptions
        • Shared Subscriptions
        • Session Attributes
        • Event History
    • Shared Subscriptions View
      • Details
    • Extension Consumers View
    • Retained Messages View
      • Details
    • Data Hub View
      • Dashboard
      • Modules
      • Schemas
      • Data Policies
      • Behavior Policies
    • Licenses View
      • Active License
        • Show Features
    • Analytics
      • Dropped Messages
        • By Reason
        • By Client
        • By Shared Subscription
        • Explanation
      • Cluster Metrics
        • Metrics Detail
    • Trace Recordings
      • Active Trace Recordings
      • Add New Trace Recordings
        • Trace Details
      • Finished Trace Recordings
      • Download Trace Recordings
    • Administration
      • Disconnect a client
      • Remove a client session
      • Manage subscriptions
      • Audit Log
      • MQTT Best Practices
    • Backup & Restore
      • Stored Backups
      • Create Backup
      • Restore From Backup
    • Diagnostic Archive
      • Stored Diagnostic Archives
      • Create Diagnostic Archive
      • Download Diagnostic Archive
  • HiveMQ Extension Developer Guide
    • Introduction
      • Ways to Explore
      • Pre-requisites
    • Quick Start Guide with Gradle
      • Use a Template
      • Develop Extension with Gradle
        • Java Project Structure
      • Test Your Extension
      • Debug Your Extension
        • Debug with HiveMQ Gradle Plugin
      • Debug with HiveMQ Testcontainer
    • Quick Start Guide with Maven
      • HiveMQ Maven Archetype
      • Create Project (Command Line)
      • Create Project (IntelliJ IDEA)
      • Create Project (Eclipse IDE)
      • Develop Extension with Maven
        • Project Structure
        • Extension Main
      • Build Extension with Maven
      • Deploy Extension
      • Test Extension
      • Debug Extension
        • Debug with HiveMQ Maven Plugin
        • Debug with HiveMQ Testcontainer
    • General Concepts
      • HiveMQ Extension Basics
        • Extension Structure
        • Extension Metadata
      • Extension Lifecycle
        • Enable or Disable Extensions
      • Extension Main Class
      • Extension Input / Output
        • Input Examples
          • Extension Start Input
          • Publish Inbound Input
        • Output Examples
          • Blocking Output Examples
          • Async Output Examples
      • Creating Objects
      • Extension Design
      • Extension Isolation
    • HiveMQ Extension Gradle Plugin
      • Domain Specific Language
        • Groovy DSL Example
        • Kotlin DSL Example
      • Gradle Tasks
        • Build Tasks
        • Run/Debug Tasks
        • Test Tasks
      • Requirements
      • Build
      • Custom Resources
      • Run and Debug
      • Integration Testing
    • HiveMQ Maven Plugin
      • Functionality
      • Workflow
      • Configuration
      • Debug Options and Modes
        • Debug with IntelliJ IDEA
        • Debug with Eclipse IDE
        • Debug with Testcontainer
      • Develop
      • Build
        • Extend Packaging
      • Deploy
    • Testing
      • Testing with Gradle
        • Packaging with Gradle
      • Testing with Maven
        • Packaging
        • Debug with Testcontainer
    • MQTT Client Authentication
      • Simple Authenticator
      • Enhanced Authenticator
      • Client Settings
    • MQTT Client Authorization
      • Default Permissions
        • Authenticator Example
        • Client Initializer Example
        • Blacklist Example
      • Publish Authorizer
        • Publish Authorizer Example
        • Async Publish Authorizer Example
      • Subscription Authorizer
        • Subscription Authorizer Example
        • Async Subscription Authorizer Example
    • Services
      • Client Service
      • Subscription Store
      • Retained Message Store
      • Connection Attribute Store
      • Publish Service
      • Managed Extension Executor Service
      • Admin Service
      • Cluster Service
    • Enterprise SDK Services
      • Consumer Service
      • Session Attribute Store
      • Extension Messaging Service
      • Control Center Service
      • REST Service
      • Client Event Service
      • Publish Attributes
    • Registries
      • Initializer Registry
      • Security Registry
      • Event Registry
      • Metric Registry
    • Interceptors
      • Connect Inbound Interceptor
      • Connack Outbound Interceptor
      • Publish Inbound Interceptor
      • Publish Outbound Interceptor
      • Puback Inbound Interceptor
      • Puback Outbound Interceptor
      • Pubrec Inbound Interceptor
      • Pubrec Outbound Interceptor
      • Pubrel Inbound Interceptor
      • Pubrel Outbound Interceptor
      • Pubcomp Inbound Interceptor
      • Pubcomp Outbound Interceptor
      • Subscribe Inbound Interceptor
      • Suback Outbound Interceptor
      • Unsubscribe Inbound Interceptor
      • Unsuback Outbound Interceptor
      • Disconnect Inbound Interceptor
      • Disconnect Outbound Interceptor
      • Pingreq Inbound Interceptor
      • Pingresp Outbound Interceptor
    • Use Cases
      • MQTT Client Authentication
      • MQTT Client Authorization
      • Lifecycle Events
      • Intercept & Manipulate
      • Send Publishes
      • Modify Subscriptions
      • Modify Retained Messages
      • Cluster Discovery
      • Metrics
    • Extension SDK API JavaDoc
  • HiveMQ Rest API
    • Introduction
    • Specification
  • HiveMQ Upgrade Guides
    • Versioning and Rolling Upgrades
      • Versioning Schema
      • Rolling Upgrade Policy
    • 4.37 to 4.38 Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
    • 4.36 to 4.37 Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
    • 4.35 to 4.36 Migration Guide
      • Data Hub Scripting and GLIBC
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
    • 4.34 to 4.35 Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
      • Outdated Metrics Removal
    • 4.33 to 4.34 Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
      • Increased Control Center Security
    • 4.32 to 4.33 Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
      • Data Hub Script Execution
    • 4.31 to 4.32 Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
    • 4.30 to 4.31 Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
    • 4.29 to 4.30 Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
      • Data Hub Validation Change
    • 4.28 to 4.29 Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
      • Changes to Data Hub Metrics
      • Data Hub Resource Limits
    • 4.9 LTS to 4.28 LTS Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
      • Changes from LTS to LTS
        • HiveMQ Configuration Validation
        • File Default Location Change
        • Control Center Permissions
        • HiveMQ Container Image Enhancements
          • File Changes
          • Linux User Handling
          • File Permissions
          • Unzip Tool Availability
    • 4.27 to 4.28 LTS Migration Guide
      • Upgrade a HiveMQ Cluster
      • Upgrade a Single-node HiveMQ Instance
      • Configuration File Changes
      • Persistent Data Migration
      • HiveMQ Container Image Enhancements
        • Linux User Handling
        • File Permissions
        • Unzip Tool Availability
    • Older Versions
      • 4.26 to 4.27 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
      • 4.25 to 4.26 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Disabled ARM64 Linux for Data Hub Transformation
      • 4.24 to 4.25 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • New Environment Variable for DataHub Scripting
        • Changes in Container Images
      • 4.23 to 4.24 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
      • 4.22 to 4.23 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
      • 4.21 to 4.22 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
      • 4.20 to 4.21 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
      • 4.19 to 4.20 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Data Hub Default Configuration Change
        • Control Center Permission Change
        • Changes in the OpenAPI for Data Hub
      • 4.18 to 4.19 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Control Center Permission Change
      • 4.17 to 4.18 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
      • 4.16 to 4.17 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
      • 4.15 to 4.16 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Native SSL Default Protocols
      • 4.14 to 4.15 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Native SSL Default Protocols
      • 4.13 to 4.14 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Native SSL Default Protocols
      • 4.12 to 4.13 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Native SSL Default Protocols
      • 4.11 to 4.12 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Native SSL Default Protocols
      • 4.10 to 4.11 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Native SSL Default Protocols
      • 4.9 to 4.10 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Native SSL Default Protocols
        • HiveMQ Configuration Validation
      • 4.8 to 4.9 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Native SSL Default Protocols
      • 4.7 to 4.8 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Native SSL Default Protocols
        • Bridge Extension Updates
      • 4.6 to 4.7 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Configuration File Changes
        • Persistent Data Migration
        • Default Authentication Behavior
        • Native SSL Default Protocols
        • HiveMQ Kubernetes Operator Updates
      • 4.5 to 4.6 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Default Authentication Behaviour
      • 4.4 to 4.5 Migration Guide
        • Upgrade a HiveMQ Cluster
        • Upgrade a Single-node HiveMQ Instance
        • Default Authentication Behaviour
        • TLS changes
      • 4.3 to 4.4 Migration Guide
        • HiveMQ Upgrade
        • Configuration File Changes
        • Persistent Data Migration
        • Cluster Upgrade
        • Default Authentication Behaviour
        • New Control Center Permissions
      • 4.3.2 to 4.3.3 Migration Guide
        • HiveMQ Extensions
        • Custom Extensions
      • 4.2 to 4.3 Migration Guide
        • HiveMQ Upgrade
        • Configuration File Changes
        • Persistent Data Migration
        • Cluster Upgrade
        • Default Authentication Behaviour
        • Resource Usage
        • New Control Center Permissions
      • 4.1 to 4.2 Migration Guide
        • HiveMQ Upgrade
        • Configuration File Changes
        • Persistent Data Migration
        • Cluster Upgrade
        • In-flight Window
      • 4.0 to 4.1 Migration Guide
        • HiveMQ Upgrade
        • Configuration File Changes
        • Persistent Data Migration
        • Cluster Upgrade
        • Enterprise Extensions
      • 3.4.4 to 4.2.1 Migration Guide
        • Prerequisites
        • Export Data From HiveMQ 3
        • Import Data to HiveMQ 4
      • 3.x.x to 4.0.x Migration Guide
        • Software Upgrade
        • Using HiveMQ 3 licenses
        • Configuration Changes
          • HiveMQ Control Center
          • Persistence Configuration
          • Listener Configuration
          • MQTT-Specific Configurations
          • Restriction Configuration
          • Extension Discovery
        • HiveMQ Extension System
        • Shared Subscriptions
        • HiveMQ Metric Changes
  • HiveMQ Upgrade Guides
  • Older Versions
Imprint