History

Andrew Mayorov fe0b8cfbaf test(conf): respect `init_config_load_done` in emqx_conf itself This should make task of configuring various applications (emqx_conf / emqx) during testsuites setup much simpler.		2023-07-04 13:20:02 +02:00
..
etc	refactor: close managment http 8081 (#5564 )	2021-08-27 13:46:39 +08:00
include	fix(management): Don't wait for an empty shard	2023-06-20 10:08:41 +02:00
src	feat: add conf load api	2023-07-04 14:17:11 +08:00
test	test(conf): respect `init_config_load_done` in emqx_conf itself	2023-07-04 13:20:02 +02:00
.gitignore	chore(emqx_management): move emqx management to apps	2021-03-02 09:35:47 +08:00
README.md	style: fix wording	2023-03-31 09:19:48 +02:00
rebar.config	refactor: move emqx_json to emqx_utils_json	2023-04-14 13:31:27 +02:00

README.md

EMQX Management

EMQX Management offers various interfaces for administrators to interact with the system, either by a remote console attached to a running node, a CLI (i.e. ./emqx ctl), or through its rich CRUD-style REST API (mostly used by EMQX' dashboard). The system enables administrators to modify both cluster and individual node configurations, and provides the ability to view and reset different statistics and metrics.

Functionality

Amongst others it allows to manage

Alarms
API Keys
Banned clients, users or hosts
Clients (and sessions) including their topic subscriptions
Configurations
Manage plugins
Fixed subscriptions
Topics

Moreover it lets you

modify hot and non-hot updatable configuration values,
publish messages, as well as bulk messages,
create trace files,
and last but not least monitor system status.

Implementation Notes

API endpoints are implemented using the minirest framework in combination with HOCON schema and OpenAPI 3.0 specifications.

TODO/FIXME

At its current state there are some reverse dependencies from other applications that do calls directly into emqx_mgmt.

Also, and somewhat related, its bpapi proto modules do calls directly into other applications.