# HiveMQ Documentation

> The HiveMQ Enterprise MQTT Broker powers the HiveMQ data streaming layer, delivering scalable, reliable, event-driven industrial IoT (IIoT) messaging. This documentation covers the HiveMQ Enterprise MQTT Broker, extensions, cloud service, edge gateway, Kubernetes operator, and HiveMQ Pulse.

## HiveMQ Enterprise MQTT Broker

- [Getting Started](https://docs.hivemq.com/hivemq/latest/user-guide/getting-started.html): Quick start guide for the HiveMQ Enterprise MQTT Broker
- [System Requirements](https://docs.hivemq.com/hivemq/latest/user-guide/system-requirements.html): Hardware, OS, and JVM requirements
- [Configuration](https://docs.hivemq.com/hivemq/latest/user-guide/configuration.html): Complete HiveMQ broker configuration reference
- [Installation](https://docs.hivemq.com/hivemq/latest/user-guide/install-hivemq.html): Installation methods for Linux, Windows, and bare metal
- [Docker Deployment](https://docs.hivemq.com/hivemq/latest/user-guide/docker.html): Running the HiveMQ broker in Docker containers
- [Clustering](https://docs.hivemq.com/hivemq/latest/user-guide/cluster.html): High availability and cluster configuration
- [Listeners](https://docs.hivemq.com/hivemq/latest/user-guide/listeners.html): TCP, WebSocket, and TLS listener configuration
- [Security](https://docs.hivemq.com/hivemq/latest/user-guide/security.html): TLS, authentication, and authorization
- [Monitoring](https://docs.hivemq.com/hivemq/latest/user-guide/monitoring.html): Metrics, JMX, and monitoring integration
- [Health API](https://docs.hivemq.com/hivemq/latest/user-guide/health-api.html): Readiness and liveness endpoints
- [Logging](https://docs.hivemq.com/hivemq/latest/user-guide/logging.html): Log configuration and dynamic log levels
- [Shared Subscriptions](https://docs.hivemq.com/hivemq/latest/user-guide/shared-subscriptions.html): Load balancing across subscribers
- [Troubleshooting](https://docs.hivemq.com/hivemq/latest/user-guide/troubleshooting.html): Common issues and diagnostics
- [Restrictions](https://docs.hivemq.com/hivemq/latest/user-guide/restrictions.html): Connection limits, bandwidth throttling, and MQTT message size limits
- [Overload Protection](https://docs.hivemq.com/hivemq/latest/user-guide/overload-protection.html): Back pressure and cluster overload protection mechanisms
- [Proxy Protocol](https://docs.hivemq.com/hivemq/latest/user-guide/proxy-protocol.html): PROXY protocol support for load balancer deployments
- [Changelog](https://www.hivemq.com/changelog/): Release notes with features, fixes, and deprecations for all HiveMQ products
- [Changelog RSS Feed](https://www.hivemq.com/changelogs.xml): Machine-readable RSS 2.0 feed of all HiveMQ product releases

## Extensions SDK

- [Extension Developer Guide](https://docs.hivemq.com/hivemq/latest/extensions/index.html): Overview of the HiveMQ broker extension system
- [Quick Start (Gradle)](https://docs.hivemq.com/hivemq/latest/extensions/quick-start-gradle.html): Build your first extension with Gradle
- [Interceptors](https://docs.hivemq.com/hivemq/latest/extensions/interceptors.html): MQTT packet interception and modification
- [Services](https://docs.hivemq.com/hivemq/latest/extensions/services.html): Extension services API reference
- [Authentication](https://docs.hivemq.com/hivemq/latest/extensions/authentication.html): Custom authentication providers
- [Authorization](https://docs.hivemq.com/hivemq/latest/extensions/authorization.html): Custom authorization providers
- [Extension Deployment](https://docs.hivemq.com/hivemq/latest/extensions/deployment.html): Building, packaging, and deploying extensions
- [Registries](https://docs.hivemq.com/hivemq/latest/extensions/registries.html): Initializer, Security, and Event registry API reference
- [Quick Start (Maven)](https://docs.hivemq.com/hivemq/latest/extensions/quick-start-maven.html): Build your first extension with Maven
- [Testing Extensions](https://docs.hivemq.com/hivemq/latest/extensions/testing-extension.html): Integration testing with HiveMQ Testcontainers

## Data Hub

- [Data Hub Overview](https://docs.hivemq.com/hivemq/latest/data-hub/index.html): Policy-driven data governance for MQTT
- [Schemas](https://docs.hivemq.com/hivemq/latest/data-hub/schemas.html): Data validation with JSON Schema, Protobuf, or Avro
- [Policies](https://docs.hivemq.com/hivemq/latest/data-hub/policies.html): Policy definition and enforcement
- [Transformations](https://docs.hivemq.com/hivemq/latest/data-hub/transformations.html): Data transformation pipelines
- [Behavior Models](https://docs.hivemq.com/hivemq/latest/data-hub/behavior-models.html): Client behavior validation
- [Data Hub Quick Start](https://docs.hivemq.com/hivemq/latest/data-hub/quick-start.html): Get started with data policies and schema validation
- [Data Validation](https://docs.hivemq.com/hivemq/latest/data-hub/validation.html): Schema-based payload validation for MQTT messages
- [Actions](https://docs.hivemq.com/hivemq/latest/data-hub/actions.html): Actions triggered by policy violations and state transitions
- [Use Cases](https://docs.hivemq.com/hivemq/latest/data-hub/use-cases.html): Practical examples for data governance scenarios
- [Data Hub Metrics](https://docs.hivemq.com/hivemq/latest/data-hub/metrics.html): Monitoring metrics for policies, schemas, and validations

## REST API

- [REST API](https://docs.hivemq.com/hivemq/latest/rest-api/index.html): HiveMQ management REST API documentation
- [OpenAPI Specification](https://docs.hivemq.com/hivemq/latest/rest-api/openapi.yaml): HiveMQ REST API OpenAPI 3.0 specification (YAML)

## Control Center

- [Control Center](https://docs.hivemq.com/hivemq-control-center/latest/index.html): Web-based management UI for HiveMQ
- [Configuration](https://docs.hivemq.com/hivemq-control-center/latest/configuration.html): Access control, user setup, and security settings
- [Clients](https://docs.hivemq.com/hivemq-control-center/latest/clients.html): Client session management, search, and detailed information
- [Dashboard](https://docs.hivemq.com/hivemq-control-center/latest/dashboard.html): Real-time cluster metrics and monitoring graphs
- [Trace Recordings](https://docs.hivemq.com/hivemq-control-center/latest/trace-recordings.html): Log and analyze MQTT traffic for specific clients or topics
- [Integrations](https://docs.hivemq.com/hivemq-control-center/latest/integrations.html): View and manage installed HiveMQ extensions and integrations

## Enterprise Extensions

- [Kafka Extension](https://docs.hivemq.com/hivemq-kafka-extension/latest/index.html): Bidirectional MQTT-Kafka bridge
- [Kafka Extension Customization](https://docs.hivemq.com/hivemq-kafka-extension/latest/customization.html): Custom transformers for MQTT-Kafka message mapping
- [Bridge Extension](https://docs.hivemq.com/hivemq-bridge-extension/latest/index.html): MQTT broker-to-broker bridging
- [Enterprise Security Extension](https://docs.hivemq.com/hivemq-enterprise-security-extension/latest/index.html): LDAP, OAuth, JWT, and database authentication
- [ESE Getting Started](https://docs.hivemq.com/hivemq-enterprise-security-extension/latest/getting-started.html): Installation, configuration, and SQL database setup
- [ESE Reference](https://docs.hivemq.com/hivemq-enterprise-security-extension/latest/ese.html): Realms, pipelines, authentication, authorization, and access control
- [Google Cloud Pub/Sub Extension](https://docs.hivemq.com/hivemq-google-cloud-pubsub-extension/latest/index.html): MQTT to Google Cloud Pub/Sub integration
- [Google Cloud Pub/Sub Quick Start](https://docs.hivemq.com/hivemq-google-cloud-pubsub-extension/latest/quick-start.html): Google Cloud setup and extension configuration
- [Amazon Kinesis Extension](https://docs.hivemq.com/hivemq-amazon-kinesis-extension/latest/index.html): MQTT to AWS Kinesis integration
- [Data Lake Extension](https://docs.hivemq.com/hivemq-data-lake-extension/latest/index.html): Stream MQTT data to data lakes
- [MongoDB Extension](https://docs.hivemq.com/hivemq-mongodb-extension/latest/index.html): Persist MQTT data to MongoDB
- [PostgreSQL Extension](https://docs.hivemq.com/hivemq-postgresql-extension/latest/index.html): Persist MQTT data to PostgreSQL
- [MySQL Extension](https://docs.hivemq.com/hivemq-mysql-extension/latest/index.html): Persist MQTT data to MySQL
- [Microsoft SQL Server Extension](https://docs.hivemq.com/hivemq-microsoft-sql-server-extension/latest/index.html): Persist MQTT data to Microsoft SQL Server
- [Snowflake Extension](https://docs.hivemq.com/hivemq-snowflake-extension/latest/index.html): Stream MQTT data to Snowflake
- [Distributed Tracing Extension](https://docs.hivemq.com/hivemq-distributed-tracing-extension/latest/index.html): OpenTelemetry tracing for MQTT
- [Distributed Tracing Spans](https://docs.hivemq.com/hivemq-distributed-tracing-extension/latest/distributed-tracing-spans.html): OpenTelemetry span details and semantic conventions

## Kubernetes Deployment

- [HiveMQ Platform Operator](https://docs.hivemq.com/hivemq-platform-operator/index.html): Deploy HiveMQ on Kubernetes with the platform operator
- [Platform Operator Configuration](https://docs.hivemq.com/hivemq-platform-operator/configuration.html): HiveMQ Platform Helm chart installation and configuration options
- [Advanced Installation](https://docs.hivemq.com/hivemq-platform-operator/configuration-kubectl.html): Install the operator and platform with kubectl using manifest files instead of Helm
- [Custom Resource Definition](https://docs.hivemq.com/hivemq-platform-operator/crd.html): CRD specification for HiveMQ Platform deployments on Kubernetes
- [Kubernetes Distributions](https://docs.hivemq.com/hivemq-platform-operator/k8s-distributions.html): Deployment on EKS, AKS, GKE, and OpenShift
- [Examples](https://docs.hivemq.com/hivemq-platform-operator/examples.html): Deployment examples and Helm chart configurations
- [Observability](https://docs.hivemq.com/hivemq-platform-operator/observability.html): Monitoring, metrics, and logging for operator deployments
- [Upgrade Guide](https://docs.hivemq.com/hivemq-platform-operator/upgrade-guide.html): Operator version migration procedures
- [Legacy Operator Migration Guide](https://docs.hivemq.com/hivemq-platform-operator/migration-guide.html): Migrate from the HiveMQ Legacy Operator to the HiveMQ Platform Operator

## HiveMQ Cloud

- [HiveMQ Cloud](https://docs.hivemq.com/hivemq-cloud/index.html): Fully managed MQTT cloud service
- [Quick Start Guide](https://docs.hivemq.com/hivemq-cloud/quick-start-guide.html): Create a cluster and connect your first MQTT client
- [Console](https://docs.hivemq.com/hivemq-cloud/console.html): Web console for cluster, organization, and integration management
- [Authentication & Authorization](https://docs.hivemq.com/hivemq-cloud/authn-authz.html): Credentials, client certificates, JWT, and role-based access control
- [Metrics](https://docs.hivemq.com/hivemq-cloud/metrics.html): Cluster monitoring and observability metrics
- [Troubleshooting](https://docs.hivemq.com/hivemq-cloud/troubleshooting.html): Log streaming, diagnostics, and issue resolution
- [REST API](https://docs.hivemq.com/hivemq-cloud/rest-api.html): Manage credentials, permissions, and roles programmatically
- [Cloud REST API OpenAPI Specification](https://docs.hivemq.com/hivemq-cloud/rest-api/openapi.yaml): HiveMQ Cloud REST API OpenAPI specification (YAML)
- [Cloud Enterprise REST API OpenAPI Specification](https://docs.hivemq.com/hivemq-cloud/rest-api/enterprise/openapi.yaml): HiveMQ Cloud Enterprise REST API OpenAPI specification (YAML)

## HiveMQ Edge

- [HiveMQ Edge](https://docs.hivemq.com/hivemq-edge/index.html): Lightweight open-source MQTT gateway for edge computing with protocol translation
- [System Requirements](https://docs.hivemq.com/hivemq-edge/system-requirements.html): OS, JDK, and hardware requirements for Edge
- [Installation](https://docs.hivemq.com/hivemq-edge/installing-hivemq-edge.html): Installation on Linux, Windows, or Kubernetes with Helm
- [Configuration](https://docs.hivemq.com/hivemq-edge/configuration.html): XML-based broker configuration for Edge
- [Protocol Adapters](https://docs.hivemq.com/hivemq-edge/protocol-adapters.html): OPC UA, Modbus, S7, BACnet, EtherNet/IP, HTTP, and more
- [Bulk Device Tag Operations](https://docs.hivemq.com/hivemq-edge/bulk-device-tag-operations.html): Browse adapter address spaces and import tags in bulk via REST API
- [MQTT Bridging](https://docs.hivemq.com/hivemq-edge/mqtt-bridging.html): Bridge MQTT messages to upstream brokers
- [Security](https://docs.hivemq.com/hivemq-edge/security.html): TLS, authentication, and authorization for Edge
- [Console](https://docs.hivemq.com/hivemq-edge/console.html): Web UI for visual management, workspace, and observability

## HiveMQ Swarm

- [HiveMQ Swarm](https://docs.hivemq.com/hivemq-swarm/latest/index.html): Distributed MQTT load testing and simulation tool
- [Scenarios](https://docs.hivemq.com/hivemq-swarm/latest/scenarios.html): Scenario DSL for defining client groups, subscriptions, and test stages
- [Commands](https://docs.hivemq.com/hivemq-swarm/latest/commands.html): Command reference (Connect, Publish, Subscribe, Receive, For, Delay, Timer)
- [Deployment](https://docs.hivemq.com/hivemq-swarm/latest/clustering.html): Distributed architecture with commander/agents, Kubernetes deployment
- [Monitoring](https://docs.hivemq.com/hivemq-swarm/latest/monitoring.html): InfluxDB and Prometheus metrics integration
- [Example Scenarios](https://docs.hivemq.com/hivemq-swarm/latest/example-scenarios.html): Templates for reconnect storms, fan-out, fan-in, steady load, and more

## HiveMQ Pulse

- [HiveMQ Pulse](https://docs.hivemq.com/hivemq-pulse/index.html): Distributed data intelligence platform for real-time processing and contextualization of operational data
- [Getting Started](https://docs.hivemq.com/hivemq-pulse/getting-started.html): Account setup, infrastructure connection, and namespace building
- [Nodes](https://docs.hivemq.com/hivemq-pulse/node-types.html): ISA-95 data modeling hierarchy (Enterprise, Site, Area, Line, Asset, Tag, Field)
- [Calculations](https://docs.hivemq.com/hivemq-pulse/calculation-types.html): Built-in analytics functions (SMA, OEE, statistics, aggregations)
- [Expression Language](https://docs.hivemq.com/hivemq-pulse/expression-language.html): Domain-specific language for real-time data processing and IoT logic
- [Governance](https://docs.hivemq.com/hivemq-pulse/governance.html): Data quality validation, deviation tracking, and resolution
- [Glossary](https://docs.hivemq.com/hivemq-pulse/glossary.html): Terminology reference for Pulse concepts

## Optional

- [Upgrade Guides](https://docs.hivemq.com/hivemq/latest/upgrade/index.html): Version migration guides from HiveMQ 3.x to 4.x
- [Load Balancer Setup](https://docs.hivemq.com/hivemq/latest/user-guide/load-balancer.html): Load balancer configuration for HiveMQ broker clusters
- [Backup & Restore](https://docs.hivemq.com/hivemq/latest/user-guide/backup-restore.html): Data backup and recovery procedures
- [MQTT Add-ons](https://docs.hivemq.com/hivemq/latest/user-guide/mqtt-add-ons.html): MQTT protocol add-on features
- [Cloud Installation](https://docs.hivemq.com/hivemq/latest/user-guide/install-in-cloud.html): Deploy the HiveMQ Enterprise MQTT Broker on AWS, Azure, GCP