Home

Welcome To HiveMQ Edge Documentation

HiveMQ Edge is lightweight, Java MQTT Broker, MQTT-SN Gateway which unifies industrial protocols into standards compliant MQTT.

image::https://github.com/hivemq/hivemq-edge/assets/5277936/17ab79ff-277e-4810-8467-80fd88e7a67a

Table of Contents

• Introduction

  • HiveMQ Edge MQTT compliance

    • Supported MQTT versions

    • Supported MQTT features

    • Additional features

    • Acknowledging QoS=1 messages

• System Requirements

  • Supported Operating Systems

  • Minimum Hardware Requirements

  • Environment

  • Linux Configuration Optimizations

• Installing HiveMQ Edge

  • Linux

  • Windows

• General Configuration Information

  • Configuration files

  • Default configuration

  • Using Environment variables

  • Custom HiveMQ folders

  • In-Memory Persistence

  • HiveMQ with IPv6

    • Necessary changes

    • Listeners

    • 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

    • Full example

• Listener Configuration

  • TCP Listener

    • Secure TCP Listener

  • WebSockets

    • Native WebSocket Listener

    • Secure WebSocket Listener

      • Websocket Gotchas

• Security

  • What is TLS

  • Java Key- and Trust Store

  • Communication Protocol

  • Cipher Suites

  • Randomness

• Logging

  • Changing the log behavior

  • Event Log

  • Syslog

• Monitoring

  • JMX

  • Available Metrics

• Shared Subscriptions

  • Shared Subscription Distribution

  • QoS Levels

• Troubleshooting

  • Using well known ports

  • Port already in use

  • Slow HiveMQ start up times

• HowTos

  • Configure server side TLS

  • Configure TLS with portecle

  • Configure TLS with client certificates