Pārlūkot izejas kodu

[docs]README新增使用入门和交流群

tomsun28 4 gadi atpakaļ
vecāks
revīzija
5e833ac749
1 mainītis faili ar 61 papildinājumiem un 1 dzēšanām
  1. 61 1
      README.md

+ 61 - 1
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 或 扫描下面账号二维码拉您进微信群。   
+<img alt="tan-cloud" src="https://cdn.jsdelivr.net/gh/usthe/hertzbeat@gh-pages/img/docs/help/tan-cloud-wechat.jpg" width="200"/>
+
+##### QQ交流群
+
+加QQ群号 718618151 或 扫描下面的群二维码进群, 验证信息: tancloud
+
+<img alt="tan-cloud" src="https://cdn.jsdelivr.net/gh/usthe/hertzbeat@gh-pages/img/docs/help/qq-qr.jpg" width="200"/>          
+
+##### 社区交流网站
+
+[社区交流](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)