From 5e833ac7497e3e2e61f6ef9c6c7139e934e0f989 Mon Sep 17 00:00:00 2001 From: tomsun28 Date: Sat, 5 Feb 2022 19:37:00 +0800 Subject: [PATCH] =?UTF-8?q?[docs]README=E6=96=B0=E5=A2=9E=E4=BD=BF?= =?UTF-8?q?=E7=94=A8=E5=85=A5=E9=97=A8=E5=92=8C=E4=BA=A4=E6=B5=81=E7=BE=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 61 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 36a15bc..dc13bb2 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,69 @@ - **[alerter](https://github.com/usthe/HertzBeat/tree/master/alerter)** 提供告警服务 > 告警计算触发，监控状态联动，告警配置，告警通知。 - **[web-app](https://github.com/usthe/HertzBeat/tree/master/web-app)** 提供可视化控制台页面 -> 监控告警系统可视化控制台前端(angular+ts+zorro) +> 监控告警系统可视化控制台前端 ![hertzBeat](https://cdn.jsdelivr.net/gh/usthe/hertzbeat@gh-pages/img/docs/hertzbeat-stru.svg) + +## 🐕 快速开始 + +- 如果您不想部署而是直接使用，我们提供SAAS监控云-[TanCloud探云](https://console.tancloud.cn)，即刻[登陆注册](https://console.tancloud.cn)免费使用。 +- 如果您是想将HertzBeat部署到内网环境搭建监控系统，请参考下面的部署文档进行操作。 + +### 🐵 依赖服务部署 + +> HertzBeat最少依赖于 关系型数据库[MYSQL8+](https://www.mysql.com/) 和 时序性数据库[TDengine2+](https://www.taosdata.com/getting-started) + +##### 安装MYSQL +1. docker安装MYSQl + `docker run -d --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql` +2. 创建名称为hertzbeat的数据库 +3. 执行位于项目仓库/script/sql/目录下的数据库脚本 [schema.sql](https://gitee.com/usthe/hertzbeat/raw/master/script/sql/schema.sql) + +详细步骤参考 [依赖服务MYSQL安装初始化](mysql-init.md) + +##### 安装TDengine +1. docker安装TDengine + `docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine` +2. 创建名称为hertzbeat的数据库 + +详细步骤参考 [依赖服务TDengine安装初始化](tdengine-init.md) + +### 🍞 HertzBeat安装 +> HertzBeat支持通过源码安装启动，Docker容器运行和安装包方式安装部署。 + +##### Docker方式快速安装 +`docker run -d -p 1157:1157 --name hertzbeat tancloud/hertzbeat:latest` + +详细步骤参考 [通过Docker方式安装HertzBeat](docker-deploy.md) + +##### 通过安装包安装 +1. 下载您系统环境对应的安装包 [GITEE Release](https://gitee.com/usthe/hertzbeat/releases) [GITHUB Release](https://github.com/usthe/hertzbeat/releases) +2. 配置HertzBeat的配置文件 hertz-beat/config/application.yml +3. 部署启动 `$ ./startup.sh ` + +详细步骤参考 [通过安装包安装HertzBeat](package-deploy.md) + +**HAVE FUN** + +## 💬 社区交流 + +##### 微信交流群 + +加微信号 tan-cloud 或 扫描下面账号二维码拉您进微信群。 +tan-cloud + +##### QQ交流群 + +加QQ群号 718618151 或 扫描下面的群二维码进群, 验证信息: tancloud + +tan-cloud + +##### 社区交流网站 + +[社区交流](https://support.qq.com/products/379369) https://support.qq.com/products/379369 + + ## 🛡️ License [`Apache License, Version 2.0`](https://www.apache.org/licenses/LICENSE-2.0.html)