Mention community project Broker for Nezha (#89)

This commit is contained in:
UUBulb
2024-08-13 13:55:04 +02:00
committed by GitHub
parent f02c88c0a3
commit b16ebc01e0
5 changed files with 82 additions and 2 deletions
+40
View File
@@ -0,0 +1,40 @@
# Broker for Nezha - 拓展 Nezha 接入平台
贡献者:
+ [uubulb](https://github.com/uubulb)
Broker for Nezha 是一个 Nezha Agent 的修改版本,其通过分离 Agent 的数据收集和 gRPC 上报功能,可使小型设备接入 Nezha Dashboard。
项目地址:<https://github.com/uubulb/broker>
文档:[Broker for Nezha](https://broker.kuzu.uk/)
## 与原项目的不同
- 使用外置数据源,而不是从本地获取。
- 多数据源与多面板支持
- 仅支持 `TaskTypeCommand` 和 `TaskTypeTerminalGRPC` 两种任务类型,均通过 SSH 实现。其它任务类型暂无计划。
Broker for Nezha 需要与特定的数据收集软件一同使用。目前提供两种数据获取方式:
1. HTTP 主动获取(HTTP/1.1)
2. TCP 被动获取(推荐,可避免创建新连接)
如需获取现有的数据收集软件,可以参考项目 README。
因数据获取方式缺乏安全性,建议仅在信任的网络环境使用。
## 编写数据收集端
如需自行编写数据收集端,除实现基本 HTTP 服务器或 TCP 客户端外,还需要使用特定的数据格式才可被 Broker 正常接收。具体请参考:[数据类型](https://broker.kuzu.uk/configuration/type/)
## 效果参考
<figure>
<img src="/images/case7/dashboard.jpg" alt="Dashboard">
<figcaption style="font-size: 0.9em; color: gray; text-align: center;">
Dashboard
</figcaption>
</figure>
<br />
<figure>
<img src="/images/case7/webssh.jpg" alt="WebSSH">
<figcaption style="font-size: 0.9em; color: gray; text-align: center;">
WebSSH
</figcaption>
</figure>