Skip to content

Commit

Permalink
[doc] add baota extern install doc (apache#2768)
Browse files Browse the repository at this point in the history
Signed-off-by: tomsun28 <[email protected]>
  • Loading branch information
tomsun28 authored Oct 11, 2024
1 parent 4f18c2c commit a0995d2
Show file tree
Hide file tree
Showing 13 changed files with 120 additions and 2 deletions.
9 changes: 9 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -2072,6 +2072,15 @@
"contributions": [
"code"
]
},
{
"login": "pruidong",
"name": "puruidong",
"avatar_url": "https://avatars.githubusercontent.com/u/13309008?v=4",
"profile": "http://www.bckf.cn/",
"contributions": [
"doc"
]
}
],
"contributorsPerLine": 7,
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,7 @@ Thanks to these wonderful people, welcome to join us:
<td align="center" valign="top" width="14.28%"><a href="https://github.com/wyfvsfy"><img src="https://avatars.githubusercontent.com/u/11973517?v=4?s=100" width="100px;" alt="wyfvsfy"/><br /><sub><b>wyfvsfy</b></sub></a><br /><a href="https://github.com/apache/hertzbeat/commits?author=wyfvsfy" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sherry-peng2333"><img src="https://avatars.githubusercontent.com/u/70619577?v=4?s=100" width="100px;" alt="sherry-peng2333"/><br /><sub><b>sherry-peng2333</b></sub></a><br /><a href="https://github.com/apache/hertzbeat/commits?author=sherry-peng2333" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/lixiaobaivv"><img src="https://avatars.githubusercontent.com/u/39290771?v=4?s=100" width="100px;" alt="Yzzz"/><br /><sub><b>Yzzz</b></sub></a><br /><a href="https://github.com/apache/hertzbeat/commits?author=lixiaobaivv" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.bckf.cn/"><img src="https://avatars.githubusercontent.com/u/13309008?v=4?s=100" width="100px;" alt="puruidong"/><br /><sub><b>puruidong</b></sub></a><br /><a href="https://github.com/apache/hertzbeat/commits?author=pruidong" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>
Expand Down
1 change: 1 addition & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,7 @@ Thanks these wonderful people, welcome to join us:
<td align="center" valign="top" width="14.28%"><a href="https://github.com/wyfvsfy"><img src="https://avatars.githubusercontent.com/u/11973517?v=4?s=100" width="100px;" alt="wyfvsfy"/><br /><sub><b>wyfvsfy</b></sub></a><br /><a href="https://github.com/apache/hertzbeat/commits?author=wyfvsfy" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sherry-peng2333"><img src="https://avatars.githubusercontent.com/u/70619577?v=4?s=100" width="100px;" alt="sherry-peng2333"/><br /><sub><b>sherry-peng2333</b></sub></a><br /><a href="https://github.com/apache/hertzbeat/commits?author=sherry-peng2333" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/lixiaobaivv"><img src="https://avatars.githubusercontent.com/u/39290771?v=4?s=100" width="100px;" alt="Yzzz"/><br /><sub><b>Yzzz</b></sub></a><br /><a href="https://github.com/apache/hertzbeat/commits?author=lixiaobaivv" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.bckf.cn/"><img src="https://avatars.githubusercontent.com/u/13309008?v=4?s=100" width="100px;" alt="puruidong"/><br /><sub><b>puruidong</b></sub></a><br /><a href="https://github.com/apache/hertzbeat/commits?author=pruidong" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>
Expand Down
43 changes: 43 additions & 0 deletions home/docs/start/baota-deploy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
id: baota-deploy
title: Use BaoTa Panel Deploy HertzBeat
sidebar_label: Install via BaoTa
---

Apache HertzBeat (incubating) supports one-click deployment in the `Docker` application store of the BaoTa panel.

## Prerequisites

Install Baota Panel, go to the [BaoTa Panel Website](https://www.bt.cn/new/index.html), switch the script and install.

## Install

1. Log in to the Baota Panel, click `Docker` menu and install the `Docker` `Docker Compose` according the prompts.

> Install the Docker service, skip if it already exists.
![HertzBeat](/img/docs/start/install-to-baota-1.png)

2. Find `HertzBeat` in `Docker App Store` and click `Install`

![HertzBeat](/img/docs/start/install-to-baota-2.png)

3. Config the domain, name and other info, click `OK`

![HertzBeat](/img/docs/start/install-to-baota-3.png)
- Name: App name, default the `HertzBeat-random`
- Version:Default `latest`
- Domain:Config if you need domain access, please configure the domain name here and resolve the domain name to the server
- Allow External Access:If you need to access directly through `IP+Port`, please check it. If you have already set the domain name, please do not check here
- Port:Default `1157`

4. After submission, the panel will automatically initialize the application, which takes about `1-3` minutes. After the initialization is completed, you can access it.

## Access HertzBeat

- If you have set a domain name, please enter the domain name directly in the browser address bar to access, such as `http://demo.hertzbeat.apache.org`, you can access the `HertzBeat` console.
- If you choose to access via `IP+Port`, please enter the domain name in the browser address bar to access `http://<Baota Panel IP>:1157`, you can access the `HertzBeat` console.

![HertzBeat](/img/home/0.png)

> Default account username: `admin` password: `hertzbeat`
4 changes: 4 additions & 0 deletions home/i18n/en/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -146,5 +146,9 @@
"sidebar.docs.category.use-case": {
"message": "UseCase",
"description": "The label for category use-case in sidebar docs"
},
"sidebar.docs.category.extern-deploy": {
"message": "Extern Install",
"description": "The label for category extern-deploy in sidebar docs"
}
}
6 changes: 5 additions & 1 deletion home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"description": "The label for category snmp in sidebar docs"
},
"sidebar.docs.link.Install via Helm": {
"message": "Kubernetes Helm部署",
"message": "Helm方式安装",
"description": "The label for link Install via Helm in sidebar docs, linking to https://artifacthub.io/packages/helm/hertzbeat/hertzbeat"
},
"sidebar.docs.category.push": {
Expand Down Expand Up @@ -150,5 +150,9 @@
"sidebar.docs.category.use-case": {
"message": "使用案例",
"description": "The label for category use-case in sidebar docs"
},
"sidebar.docs.category.extern-deploy": {
"message": "集成平台部署",
"description": "The label for category extern-deploy in sidebar docs"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
id: baota-deploy
title: 使用 宝塔面板 部署 HertzBeat
sidebar_label: 基于宝塔面板部署
---

Apache HertzBeat (incubating) 支持在宝塔面板的 `Docker` 应用商店一键部署。

## 前提

安装宝塔面板,前往[宝塔面板](https://www.bt.cn/new/index.html)官网,选择对应的脚本下载安装。

## 部署

1. 登录宝塔面板,在菜单栏中点击 `Docker`,根据提示安装 `Docker``Docker Compose` 服务。

> 在宝塔面板安装 Docker 服务,若已有则跳过。
![HertzBeat](/img/docs/start/install-to-baota-1.png)

2.`Docker-应用商店`中找到 `HertzBeat`,点击`安装`

![HertzBeat](/img/docs/start/install-to-baota-2.png)

3. 设置域名等基本信息,点击`确定`

![HertzBeat](/img/docs/start/install-to-baota-3.png)

- 名称:应用名称,默认`HertzBeat-随机字符`
- 版本选择:默认`latest`
- 域名:如需通过域名直接访问,请在此配置域名并将域名解析到服务器
- 允许外部访问:如您需通过`IP+Port`直接访问,请勾选,如您已经设置了域名,请不要勾选此处
- 端口:默认`1157`,可自行修改

4. 提交后面板会自动进行应用初始化,大概需要`1-3`分钟,初始化完成后即可访问。

## 访问 HertzBeat

- 如您设置了域名,请直接在浏览器地址栏中输入域名访问,如`http://demo.hertzbeat.apache.org`,即可访问 `HertzBeat` 控制台。
- 如您选择了通过`IP+Port`访问,请在浏览器地址栏中输入域名访问 `http://<宝塔面板IP>:1157`,即可访问 `HertzBeat` 控制台。

![HertzBeat](/img/home/0.png)

> 默认用户名`admin`默认密码`hertzbeat`
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: rainbond-deploy
title: 使用 Rainbond 部署 HertzBeat
sidebar_label: Rainbond方式部署
sidebar_label: 基于Rainbond部署
---

如果你不熟悉 Kubernetes,想在 Kubernetes 中安装 Apache HertzBeat (incubating),可以使用 Rainbond 来部署。Rainbond 是一个基于 Kubernetes 构建的云原生应用管理平台,可以很简单的将你的应用部署到 Kubernetes中。
Expand Down
8 changes: 8 additions & 0 deletions home/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@
"type": "link",
"label": "Install via Helm",
"href": "https://artifacthub.io/packages/helm/hertzbeat/hertzbeat"
},
{
"type": "category",
"label": "extern-deploy",
"items": [
"start/baota-deploy",
"start/rainbond-deploy"
]
}
]
},
Expand Down
4 changes: 4 additions & 0 deletions home/src/pages/team/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -1150,6 +1150,10 @@ export default function () {
src="https://avatars.githubusercontent.com/u/39290771?v=4?s=100" width="100px;"
alt="Yzzz"/><br/><sub><b>Yzzz</b></sub></a><br/><a
href="https://github.com/apache/hertzbeat/commits?author=lixiaobaivv" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.bckf.cn/"><img
src="https://avatars.githubusercontent.com/u/13309008?v=4?s=100" width="100px;"
alt="puruidong"/><br/><sub><b>puruidong</b></sub></a><br/><a
href="https://github.com/apache/hertzbeat/commits?author=pruidong" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a0995d2

Please sign in to comment.