LogoLogo
2.0.0
1.7.11.8.01.12.31.9.01.10.01.10.3master2.0.01.13.0
2.0.0
1.7.11.8.01.12.31.9.01.10.01.10.3master2.0.01.13.0
  • 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
    • REST Publisher
  • VerneMQ Clustering
    • Introduction
    • Inter-node Communication
    • Dealing with Netsplits
  • Live Administration
    • Introduction
    • Inspecting and managing sessions
    • Retained messages
    • Live reconfiguration
    • Managing Listeners
    • Certificate Management
    • HTTP API
    • Tracing
    • Output Format
  • 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
    • Migrating to 2.0
Powered by GitBook
On this page
  • General Format of the vernemq.conf file
  • Minimal Quickstart Configuration

Was this helpful?

Edit on GitHub
Export as PDF
  1. Configuring VerneMQ

Introduction

Everything you must know to properly configure VerneMQ

PreviousRunning VerneMQ using DockerNextThe VerneMQ conf file

Last updated 11 months ago

Was this helpful?

Every VerneMQ node has to be configured as the default configuration probably does not match your needs. Depending on the installation method and chosen platform the configuration file vernemq.conf resides at different locations. If VerneMQ was installed through a Linux package the default location for the configuration file is /etc/vernemq/vernemq.conf.

General Format of the vernemq.conf file

  • A single setting is handled on one line.

  • Lines are structured Key = Value

  • Any line starting with # is a comment, and will be ignored.

Minimal Quickstart Configuration

You certainly want to try out VerneMQ right away. To just check the broker without configured authentication for now, you can allow anonymous access:

  • Set allow_anonymous = on

By default the vmq_acl authorization plugin is enabled and configured to allow publishing and subscribing to any topic (basically allowing everything), check the for more information.

Setting allow_anonymous=on completely disables authentication in the broker and plugin authentication hooks are never called! Find the details on all the authentication hooks . In a production system you should configure vmq_acl to be less permissive or configure some other plugin to handle authorization.

here
section on file-based authorization