diff --git a/README.md b/README.md index 1f98b8d3bf06042a9b3b7daae761cf1b539b48d3..6385ca3f14451e60d3dcb583e88522e38ede7038 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,40 @@ -简体中文 | [English](./README-EN.md) + # 💎 Easy MQTT 一款简单、实用的`MQTT`服务器(代理) ## 🎯目标 -让一切保持简单 +- 提供轻量级MQTT消息代理服务 +- 支持QoS 0/1/2消息传递 +- 提供集群部署能力 +- 支持WebSocket连接 +- 支持SSL加密传输 ## 💪 功能 -- [x] **极简的启动方式及配置项** -- [x] **支持单机/集群** -- [x] **支持数据持久化** -- [x] 支持完整的MQTT v3.1.1协议 -- [x] 支持WebSocket MQTT子协议 -- [x] 支持在建立MQTT连接时通过外部接口进行认证 -- [x] 支持以SSL的方式建立TCP/WebSocket连接 +- 完整实现MQTT协议核心功能 +- 消息持久化存储 +- 客户端会话管理 +- 主题过滤与保留消息支持 +- 多数据库支持(H2/MySQL/SQLite) +- 内置RAFT协议实现集群高可用 +- 提供RPC服务支持集群通信 +- 自动消息ID生成与管理 +- 支持异步任务处理 +- 完善的日志与监控体系 ## 🚀 快速开始 -### 1.下载安装Easy MQTT -点击 [这里](https://gitee.com/EasyProgramming/easy-mqtt/releases) 下载最新的已编译的easy mqtt压缩包,并解压 -### 2.启动Easy MQTT -```shell script +### 1. 下载安装Easy MQTT +```shell +# 克隆仓库 +git clone https://gitee.com/ep/easy-mqtt.git +``` + +### 2. 启动Easy MQTT +```shell +# 修改配置文件 +vim conf/conf.yml + +# 启动服务 sh bin/start.sh -c conf/conf.yml ``` @@ -27,8 +42,8 @@ sh bin/start.sh -c conf/conf.yml - [必要参数说明](./doc/必要参数说明.md) - [集群部署示例](./doc/集群部署示例.md) - [开启鉴权](./doc/开启鉴权.md) -- [开启ssl](./doc/开启ssl.md) -- [开启websocket](./doc/开启websocket.md) +- [开启SSL](./doc/开启ssl.md) +- [开启WebSocket](./doc/开启websocket.md) ## 开源许可 -详见 [LICENSE](./LICENSE) \ No newline at end of file +详见 [LICENSE](./LICENSE) 文件 \ No newline at end of file