CompanyServicesBlogDownloads
Search…
1.12.3
Welcome
Getting Started
Downloads
VerneMQ / MQTT Introduction
Installing VerneMQ
Installing on Debian and Ubuntu
Installing on CentOS and RHEL
Running VerneMQ using Docker
Configuring VerneMQ
Introduction
The VerneMQ conf file
Auth using files
Auth using a database
MQTT Options
MQTT Listeners
HTTP Listeners
Non-standard MQTT options
Websockets
Logging
Consumer session balancing
Plugins
Shared subscriptions
Advanced Options
Storage
MQTT Bridge
VerneMQ Clustering
Introduction
Inter-node Communication
Dealing with Netsplits
Live Administration
Introduction
Inspecting and managing sessions
Retained messages
Live reconfiguration
Managing Listeners
HTTP API
Tracing
Monitoring
Introduction
$SYSTree
Graphite
Netdata
Prometheus
Health Checker
Status Page
Plugin Development
Introduction
Session lifecycle
Subscribe Flow
Publish Flow
Enhanced Auth Flow
Erlang Boilerplate
Lua Scripting Support
Webhooks
Misc
Loadtesting VerneMQ
Not a tuning guide
Change Open File Limits
Guides
A typical VerneMQ deployment
VerneMQ on Kubernetes
Loadtesting VerneMQ
Clustering during development
Not a tuning guide
Change Open File Limits
Powered By GitBook
Welcome
Welcome to the VerneMQ documentation! This is a reference guide for most of the available features and options of VerneMQ. The Getting Started guide might be a good entry point.
The VerneMQ documentation is based on the VerneMQ Documentation project. Any changes on Github are automatically deployed to the VerneMQ online Documentation.
For a more general overview on VerneMQ and MQTT, you might want to start with the introduction.
For downloading the subscription-based binary VerneMQ packages and/or a quick description on how to compile VerneMQ from sources, see Downloads.

How to help improve this documentation

The VerneMQ Documentation project is an open-source effort, and your contributions are very welcome and appreciated. You can contribute on all levels:
  • Language, style and typos
  • Fixing obvious documentation errors and gaps
  • Providing more details and/or examples for specific topics
  • Extending the documentation where you find this useful to do
Note that the documentation is versioned according to the VerneMQ releases. You can click the "Edit on Github" button in the upper right corner of every page to check what branch and document you are on. You can then create a Pull Request (PR) against that branch from your fork of the VerneMQ documentation repository. (Direct edits on Github are possible for members of the doc repository).
Next
Getting Started
Last modified 4mo ago
Export as PDF
Copy link
Edit on GitHub
Contents
How to help improve this documentation