User Guides

Instructions on performing various EMQX operations.

These guides help administrators and operators manage, configure, secure, monitor, and maintain EMQX deployments. The main contents in this chapter include:

• Cluster Management covers how to create and manage an EMQX cluster, including cluster architecture, cluster security, load balancer configuration, node evacuation, cluster load rebalancing, and performance tuning.
• Configure EMQX provides basic information about the configuration file, configuration options, and references for detailed configurations.
• Namespace explains how to logically group MQTT clients and manage tenant-level isolation, quotas, and rate limits within a shared EMQX cluster.
• REST API guides you on getting started with the HTTP management API exposed by EMQX for managing clients, topics, subscriptions, and more.
• Command Line Interface introduces various startup and management commands supported by EMQX.
• Security Guide covers network and TLS configuration, authentication, authorization, banned clients, flapping detection, identity governance, audit logs, rate limits, and backup and restore.
• MQTT Durable Sessions guides you to configure the Durable Sessions feature and set parameters for data replicas for high availability.
• EMQX Dashboard provides a comprehensive introduction to the built-in management console in EMQX. You will learn how to manage and monitor EMQX clusters, configure various features, and use the required functionalities.
• Logs and Observability introduces metric observation and monitoring features in EMQX, facilitating system monitoring and debugging.
• Extensions helps you extend EMQX through extension mechanisms such as hooks and gRPC hooks.
• Plugins helps you develop, customize, manage, and use EMQX plugins.
• Telemetry explains how to share your usage information by enabling telemetry to help improve the product.