This is an automated email from the ASF dual-hosted git repository.
gongchao pushed a commit to branch footer-apache
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/footer-apache by this push:
new 2cd31ae8a update doc
2cd31ae8a is described below
commit 2cd31ae8a9360f36d60991338982368f332819f7
Author: tomsun28 <[email protected]>
AuthorDate: Sat Apr 27 10:54:19 2024 +0800
update doc
---
home/docs/start/account-modify.md | 4 +++-
home/docs/start/greptime-init.md | 3 ++-
home/docs/start/influxdb-init.md | 4 ++--
home/docs/start/iotdb-init.md | 7 ++++---
home/docs/start/tdengine-init.md | 3 ++-
home/docs/start/victoria-metrics-init.md | 4 ++--
.../current/start/account-modify.md | 6 ++++--
.../current/start/greptime-init.md | 3 ++-
.../current/start/influxdb-init.md | 3 ++-
.../docusaurus-plugin-content-docs/current/start/iotdb-init.md | 9 +++++----
.../current/start/tdengine-init.md | 3 ++-
.../current/start/victoria-metrics-init.md | 3 ++-
home/sidebars.json | 2 +-
13 files changed, 33 insertions(+), 21 deletions(-)
diff --git a/home/docs/start/account-modify.md
b/home/docs/start/account-modify.md
index fc1cd57c2..820d2a57d 100644
--- a/home/docs/start/account-modify.md
+++ b/home/docs/start/account-modify.md
@@ -1,9 +1,11 @@
---
id: account-modify
title: Modify Account Username Password And Secret
-sidebar_label: Update Account
+sidebar_label: Update Account Secret
---
+## Update Account
+
HertzBeat default built-in three user accounts, respectively admin/hertzbeat
tom/hertzbeat guest/hertzbeat
If you need add, delete or modify account or password, configure
`sureness.yml`. Ignore this step without this demand.
The configuration file content refer to project
repository[/script/sureness.yml](https://gitee.com/hertzbeat/hertzbeat/blob/master/script/sureness.yml)
diff --git a/home/docs/start/greptime-init.md b/home/docs/start/greptime-init.md
index e4fcbe982..ef2de3527 100644
--- a/home/docs/start/greptime-init.md
+++ b/home/docs/start/greptime-init.md
@@ -5,7 +5,8 @@ sidebar_label: Use GreptimeDB Store Metrics
---
HertzBeat's historical data storage relies on the time series database, you
can choose one of them to install and initialize, or not to install (note ⚠️
but it is strongly recommended to configure in the production environment)
-We recommend VictoriaMetrics for long term support.
+
+> It is recommended to use VictoriaMetrics as metrics storage.
GreptimeDB is an open-source time-series database with a special focus on
scalability, analytical capabilities and efficiency.
diff --git a/home/docs/start/influxdb-init.md b/home/docs/start/influxdb-init.md
index 72cf7ca61..1d1ed5b43 100644
--- a/home/docs/start/influxdb-init.md
+++ b/home/docs/start/influxdb-init.md
@@ -5,9 +5,9 @@ sidebar_label: Use InfluxDB Store Metrics
---
HertzBeat's historical data storage relies on the time series database, you
can choose one of them to install and initialize, or not to install (note ⚠️
but it is strongly recommended to configure in the production environment)
-We recommend VictoriaMetrics for long term support.
-TDengine is the Time Series Data Platform where developers build IoT,
analytics, and cloud applications.
+> It is recommended to use VictoriaMetrics as metrics storage.
+
**Note⚠️ Time series database is optional, but production environment
configuration is strongly recommended to provide more complete historical chart
functions and high performance**
**⚠️ If you do not configure a time series database, only the last hour of
historical data is retained.**
diff --git a/home/docs/start/iotdb-init.md b/home/docs/start/iotdb-init.md
index 573296219..57ac4dfbc 100644
--- a/home/docs/start/iotdb-init.md
+++ b/home/docs/start/iotdb-init.md
@@ -5,7 +5,8 @@ sidebar_label: Use IoTDB Store Metrics
---
HertzBeat's historical data storage relies on the time series database, you
can choose one of them to install and initialize, or not to install (note ⚠️
but it is strongly recommended to configure in the production environment)
-We recommend VictoriaMetrics for long term support.
+
+> It is recommended to use VictoriaMetrics as metrics storage.
Apache IoTDB is a software system that integrates the collection, storage,
management and analysis of time series data of the Internet of Things. We use
it to store and analyze the historical data of monitoring metrics collected.
Support V0.13+ version and V1.0.+ version.
@@ -30,7 +31,7 @@ Apache IoTDB is a software system that integrates the
collection, storage, manag
$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \
-v /opt/iotdb/data:/iotdb/data \
--name iotdb \
- apache/iotdb:0.13.3-node
+ apache/iotdb:1.2.2-standalone
```
`-v /opt/iotdb/data:/iotdb/data` is local persistent mount of IotDB data
directory.`/iotdb/data` should be replaced with the actual local directory.
@@ -56,7 +57,7 @@ warehouse:
username: root
password: root
# config.org.apache.hertzbeat.warehouse.IotDbVersion: V_0_13 || V_1_0
- version: V_0_13
+ version: V_1_0
query-timeout-in-ms: -1
# default '7776000000'（90days,unit:ms,-1:no-expire）
expire-time: '7776000000'
diff --git a/home/docs/start/tdengine-init.md b/home/docs/start/tdengine-init.md
index 928e9b258..57d8a360b 100644
--- a/home/docs/start/tdengine-init.md
+++ b/home/docs/start/tdengine-init.md
@@ -5,7 +5,8 @@ sidebar_label: Use TDengine Store Metrics
---
HertzBeat's historical data storage relies on the time series database, you
can choose one of them to install and initialize, or not to install (note ⚠️
but it is strongly recommended to configure in the production environment)
-We recommend VictoriaMetrics for long term support.
+
+> It is recommended to use VictoriaMetrics as metrics storage.
TDengine is an open-source IoT time-series database, which we use to store the
collected historical data of monitoring metrics. Pay attention to support ⚠️
3.x version.
diff --git a/home/docs/start/victoria-metrics-init.md
b/home/docs/start/victoria-metrics-init.md
index c917d5cb7..cd9d5a821 100644
--- a/home/docs/start/victoria-metrics-init.md
+++ b/home/docs/start/victoria-metrics-init.md
@@ -1,12 +1,12 @@
---
id: victoria-metrics-init
title: Use Time Series Database VictoriaMetrics to Store Metrics Data
(Recommended)
-sidebar_label: Use VictoriaMetrics Store Metrics
+sidebar_label: Use VictoriaMetrics Store Metrics(Recommended)
---
HertzBeat's historical data storage relies on the time series database, you
can choose one of them to install and initialize, or not to install (note ⚠️
but it is strongly recommended to configure in the production environment)
-We recommend VictoriaMetrics for long term support.
+> It is recommended to use VictoriaMetrics as metrics storage.
VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and
time series database.Recommend Version(VictoriaMetrics:v1.95.1+,
HertzBeat:v1.4.3+)
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md
index e75a5d0fd..50f05a20f 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/account-modify.md
@@ -1,9 +1,11 @@
---
id: account-modify
-title: 配置修改账户和密钥
-sidebar_label: 配置修改账户密码
+title: 更新账户和密钥
+sidebar_label: 配置修改账户密码和加密密钥
---
+## 更新账户
+
HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat
若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤
修改位于安装目录下的 `/hertzbeat/config/sureness.yml`
的配置文件，docker环境目录为`opt/hertzbeat/config/sureness.yml`，建议提前挂载映射
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md
index 4c98f1572..c3315106a 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/greptime-init.md
@@ -5,7 +5,8 @@ sidebar_label: 使用GreptimeDB存储指标数据(可选)
---
HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置)
-我们推荐使用并长期支持VictoriaMetrics
+
+> 我们推荐使用并长期支持 VictoriaMetrics 作为存储。
GreptimeDB is an open-source time-series database with a special focus on
scalability, analytical capabilities and efficiency.
It's designed to work on infrastructure of the cloud era, and users benefit
from its elasticity and commodity storage.
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md
index f98fb8374..b8c07cfc6 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/influxdb-init.md
@@ -5,7 +5,8 @@ sidebar_label: 使用InfluxDB存储指标数据(可选)
---
HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置)
-我们推荐使用并长期支持VictoriaMetrics
+
+> 我们推荐使用并长期支持 VictoriaMetrics 作为存储。
InfluxDB是一个由InfluxData开发的开源时序型数据库，专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️
1.x版本。
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md
index bc37b3149..35b699347 100644
--- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/iotdb-init.md
@@ -5,7 +5,8 @@ sidebar_label: 使用IoTDB存储指标数据(可选)
---
HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置)
-我们推荐使用并长期支持VictoriaMetrics
+
+> 我们推荐使用并长期支持 VictoriaMetrics 作为存储。
Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据的软件系统，我们使用其存储分析采集到的监控指标历史数据。支持V0.12 -
V0.13版本，推荐使用V0.13.*版本。
@@ -30,7 +31,7 @@ Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据
$ docker run -d -p 6667:6667 -p 31999:31999 -p 8181:8181 \
-v /opt/iotdb/data:/iotdb/data \
--name iotdb \
- apache/iotdb:0.13.3-node
+ apache/iotdb:1.2.2-standalone
```
`-v /opt/iotdb/data:/iotdb/data`
为IoTDB数据目录本地持久化挂载，需将`/iotdb/data`替换为实际本地存在的目录
@@ -57,8 +58,8 @@ warehouse:
rpc-port: 6667
username: root
password: root
- # V_O_12 || V_0_13
- version: V_0_13
+ # V_0_13 || V_1_0
+ version: V_1_0
# if iotdb version >= 0.13 use default queryTimeoutInMs = -1; else use
default queryTimeoutInMs = 0
query-timeout-in-ms: -1
# 数据存储时间：默认'7776000000'（90天,单位为毫秒,-1代表永不过期）
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md
index 1b70a487d..62ff70e0f 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/tdengine-init.md
@@ -5,7 +5,8 @@ sidebar_label: 使用TDengine存储指标数据(可选)
---
HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置)
-我们推荐使用并长期支持VictoriaMetrics
+
+> 我们推荐使用并长期支持 VictoriaMetrics 作为存储。
TDengine是一款开源物联网时序型数据库，我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md
index 8c9ae0870..ff16191e5 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/victoria-metrics-init.md
@@ -5,7 +5,8 @@ sidebar_label: 使用VictoriaMetrics存储指标数据(推荐)
---
HertzBeat的历史数据存储依赖时序数据库，任选其一安装初始化即可，也可不安装(注意⚠️但强烈建议生产环境配置)
-我们推荐使用并长期支持VictoriaMetrics
+
+> 我们推荐使用并长期支持 VictoriaMetrics 作为存储。
VictoriaMetrics，是一个快速高效、经济并且可扩展的监控解决方案和时序数据库，兼容 Prometheus
生态。推荐版本(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+)
diff --git a/home/sidebars.json b/home/sidebars.json
index 94ae29090..d248f6900 100755
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -14,6 +14,7 @@
"label": "Install via Helm",
"href": "https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
},
+ "start/account-modify",
"start/upgrade",
"start/victoria-metrics-init",
"start/iotdb-init",
@@ -22,7 +23,6 @@
"start/influxdb-init",
"start/mysql-change",
"start/postgresql-change",
- "start/account-modify",
"start/custom-config",
"start/ssl-cert-practice"
]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
