# VerneMQ

## VerneMQ

- [Welcome](https://courier-gojek.gitbook.io/vernemq/readme.md)
- [Getting Started](https://courier-gojek.gitbook.io/vernemq/getting-started.md): A quick and simple guide to get started with VerneMQ
- [Running VerneMQ using Docker](https://courier-gojek.gitbook.io/vernemq/installing-vernemq/docker.md): As well as being available as packages that can be installed directly into the operating systems, VerneMQ is also available as a Docker image. Below is an example of how to set up a couple of VerneMQ
- [Introduction](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/introduction.md): Everything you must know to properly configure VerneMQ
- [The VerneMQ conf file](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/the-vernemq-conf-file.md): A closer look at an example vernemq.conf file (Note: This is a work-in-progress section)
- [Auth using files](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/file-auth.md)
- [Auth using a database](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/db-auth.md): VerneMQ supports multiple ways to authenticate and authorize new client connections using a database.
- [Enhanced Auth](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/customauth.md)
- [MQTT Options](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/options.md): Configure how VerneMQ handles certain aspects of MQTT
- [MQTT Listeners](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/listeners.md): VerneMQ supports multiple ways to configure one or many MQTT listeners.
- [HTTP Listeners](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/http-listeners.md): How to setup and configure the HTTP listener.
- [Non-standard MQTT options](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/nonstandard.md): Configure Non-Standard MQTT Options VerneMQ Supports.
- [Websockets](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/websockets.md): Configure WebSocket Listeners for VerneMQ.
- [Logging](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/logging.md): Configure VerneMQ Logging.
- [Consumer session balancing](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/balancing.md): MQTT consumers can share and loadbalance a topic subscription.
- [Plugins](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/plugins.md): Managing VerneMQ Plugins
- [Shared subscriptions](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/shared_subscriptions.md): Working with shared subscriptions
- [Advanced Options](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/advanced_options.md): Configure a couple of hidden options for VerneMQ
- [Storage](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/storage.md)
- [No Op Engine](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/noopengine.md): Configure how VerneMQ implements message persistence
- [Generic offline store](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/genericofflinestore.md): Configure offline message store.
- [Redis based message passing](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/messagepassing.md): New message passing model for VerneMQ
- [Redis based subscription store](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/routing.md): Configure Routing store.
- [MQTT Bridge](https://courier-gojek.gitbook.io/vernemq/configuring-vernemq/bridge.md): VerneMQ can interface with other brokers (and itself) via MQTT bridges.
- [Introduction](https://courier-gojek.gitbook.io/vernemq/vernemq-clustering/introduction.md): Everything you must know to properly configure and deploy a VerneMQ Cluster
- [Inter-node Communication](https://courier-gojek.gitbook.io/vernemq/vernemq-clustering/communication.md): Everything you must know to properly configure and deploy a VerneMQ Cluster
- [Dealing with Netsplits](https://courier-gojek.gitbook.io/vernemq/vernemq-clustering/netsplits.md): How does VerneMQ deals with Network Partitions aka. Netsplits.
- [Introduction](https://courier-gojek.gitbook.io/vernemq/live-administration/introduction.md)
- [Inspecting and managing sessions](https://courier-gojek.gitbook.io/vernemq/live-administration/managing-sessions.md): Inspecting and managing MQTT sessions
- [Retained messages](https://courier-gojek.gitbook.io/vernemq/live-administration/retained-store.md): Inspecting the retained message store
- [Live reconfiguration](https://courier-gojek.gitbook.io/vernemq/live-administration/config_values.md): Managing VerneMQ live config values.
- [Managing Listeners](https://courier-gojek.gitbook.io/vernemq/live-administration/listeners.md): Managing VerneMQ tcp listeners
- [HTTP API](https://courier-gojek.gitbook.io/vernemq/live-administration/http-administration.md): Everything you need to know to work with the VerneMQ HTTP administration interface
- [Tracing](https://courier-gojek.gitbook.io/vernemq/live-administration/tracing.md): Real-time inspection
- [Introduction](https://courier-gojek.gitbook.io/vernemq/monitoring/introduction.md): Description and Configuration of the built-in Monitoring mechanism
- [$SYSTree](https://courier-gojek.gitbook.io/vernemq/monitoring/systree.md): Description and Configuration of the $SYSTree Monitoring Feature
- [Graphite](https://courier-gojek.gitbook.io/vernemq/monitoring/graphite.md): Description and Configuration of the Graphite exporter
- [Netdata](https://courier-gojek.gitbook.io/vernemq/monitoring/netdata.md): Netdata Metrics
- [Prometheus](https://courier-gojek.gitbook.io/vernemq/monitoring/prometheus.md): Description and Configuration of the Prometheus exporter
- [Health Checker](https://courier-gojek.gitbook.io/vernemq/monitoring/health-check.md): The VerneMQ health checker
- [Status Page](https://courier-gojek.gitbook.io/vernemq/monitoring/status.md): The VerneMQ Status Page
- [Introduction](https://courier-gojek.gitbook.io/vernemq/plugin-development/introduction.md): Learn how to implement VerneMQ Plugins for customizing many aspects of  how VerneMQ deals with client connections, subscriptions, and message flows.
- [Session lifecycle](https://courier-gojek.gitbook.io/vernemq/plugin-development/sessionlifecycle.md)
- [Subscribe Flow](https://courier-gojek.gitbook.io/vernemq/plugin-development/subscribeflow.md)
- [Publish Flow](https://courier-gojek.gitbook.io/vernemq/plugin-development/publishflow.md)
- [Enhanced Auth Flow](https://courier-gojek.gitbook.io/vernemq/plugin-development/enhancedauthflow.md)
- [Erlang Boilerplate](https://courier-gojek.gitbook.io/vernemq/plugin-development/boilerplate.md)
- [Lua Scripting Support](https://courier-gojek.gitbook.io/vernemq/plugin-development/luaplugins.md): Learn how to implement VerneMQ plugins using the Lua Scripting Language.
- [Webhooks](https://courier-gojek.gitbook.io/vernemq/plugin-development/webhookplugins.md): How to implement VerneMQ plugins using a HTTP interface
- [Events sidecar Plugin](https://courier-gojek.gitbook.io/vernemq/plugin-development/eventssidecarplugins.md): How to implement VerneMQ plugins using a TCP sidecar
- [Loadtesting VerneMQ](https://courier-gojek.gitbook.io/vernemq/misc/loadtesting.md): Loadtesting VerneMQ with vmq\_mzbench
- [Not a tuning guide](https://courier-gojek.gitbook.io/vernemq/misc/not-a-tuning-guide.md)
- [Change Open File Limits](https://courier-gojek.gitbook.io/vernemq/misc/change-open-file-limits.md): How to change the open file limits
- [A typical VerneMQ deployment](https://courier-gojek.gitbook.io/vernemq/guides/typical-vernemq-deployment.md): In the following we describe how a typical VerneMQ deployment can look and some of the concerns one have to take into account when designing such a system.
- [VerneMQ on Kubernetes](https://courier-gojek.gitbook.io/vernemq/guides/vernemq-on-kubernetes.md): This guide describes how to deploy a VerneMQ cluster on Kubernetes
- [Loadtesting VerneMQ](https://courier-gojek.gitbook.io/vernemq/guides/loadtesting.md): Loadtesting VerneMQ with vmq\_mzbench
- [Clustering during development](https://courier-gojek.gitbook.io/vernemq/guides/clustering-during-development.md): This describes a quick way to create a VerneMQ cluster on developer's machines
- [Not a tuning guide](https://courier-gojek.gitbook.io/vernemq/guides/not-a-tuning-guide.md)
- [Change Open File Limits](https://courier-gojek.gitbook.io/vernemq/guides/change-open-file-limits.md): A guide that shows how to change the open file limtits