update package deploy doc (#1330)

apache · Nov 12, 2023 · 28ff4c0 · 28ff4c0
1 parent c6ebcd3
commit 28ff4c0
Show file tree

Hide file tree

Showing 10 changed files with 128 additions and 140 deletions.
diff --git a/README.md b/README.md
@@ -124,14 +124,12 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do
 
 ##### 2：Install via package  
 
-1. Download the release package `hertzbeat-xx.zip` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
-2. Need `java jdk11` Environment
-3. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional)  
-4. Run command `$ ./bin/startup.sh ` or `bin/startup.bat`   
-5. Access `http://localhost:1157` to start, default account: `admin/hertzbeat`  
-6. Deploy collector clusters
-    - Download the release package `hertzbeat-collector-xx.zip` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
-    - Need `java jdk11` Environment
+1. Download the release package `hertzbeat-xx.tar.gz` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
+2. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional)  
+3. Run command `$ ./bin/startup.sh ` or `bin/startup.bat`   
+4. Access `http://localhost:1157` to start, default account: `admin/hertzbeat`  
+5. Deploy collector clusters
+    - Download the release package `hertzbeat-collector-xx.tar.gz` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
     - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port`
       ```yaml
       collector:

diff --git a/README_CN.md b/README_CN.md
@@ -122,14 +122,12 @@ docker run -d -e IDENTITY=custom-collector-name -e MANAGER_HOST=127.0.0.1 -e MAN
 
 ##### 方式二：通过安装包安装
 
-1. 下载您系统环境对应的安装包`hertzbeat-xx.zip` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
-2. 需要提前已安装`java jdk11`环境   
-3. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选)
-4. 部署启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat`
-5. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat`
-6. 部署采集器集群
-   - 下载采集器安装包`hertzbeat-collector-xx.zip`到规划的另一台部署主机上 [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
-   - 需要提前已安装`java jdk11`环境 
+1. 下载您系统环境对应的安装包`hertzbeat-xx.tar.gz` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
+2. 配置 HertzBeat 的配置文件 `hertzbeat/config/application.yml`(可选)
+3. 部署启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat`
+4. 浏览器访问 `http://localhost:1157` 即可开始，默认账号密码 `admin/hertzbeat`
+5. 部署采集器集群
+   - 下载采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上 [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
    - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml` 里面的连接主HertzBeat服务的对外IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or private) `manager-host` `manager-port`
      ```yaml
      collector:

diff --git a/home/docs/start/package-deploy.md b/home/docs/start/package-deploy.md
@@ -3,61 +3,44 @@ id: package-deploy
 title: Install HertzBeat via Package 
 sidebar_label: Install via Package
 ---
-> You can install and run HertzBeat on Linux Windows Mac system, and CPU supports X86/ARM64. Due to the installation package itself does not include the JAVA runtime environment, you need to prepare JAVA runtime environment in advance.
+> You can install and run HertzBeat on Linux Windows Mac system, and CPU supports X86/ARM64.
 
-1. Install JAVA runtime environment-refer to [official website](http://www.oracle.com/technetwork/java/javase/downloads/index.html)    
-   requirement：JDK11 ENV     
-   download JAVA installation package: [mirror website](https://repo.huaweicloud.com/java/jdk/)   
-   After installation use command line to check whether you install it successfully.   
-   ```
-   $ java -version
-   java version "11.0.12" 
-   Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237)
-   Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode)
-
-   ```
-
-2. Download HertzBeat installation package    
-   Download installation package `hertzbeat-xx.zip` `hertzbeat-collector-xx.zip` corresponding to your system environment   
+1. Download HertzBeat installation package    
+   Download installation package `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz` corresponding to your system environment   
    - download from [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) repository 
    - download from [GITHUB Release](https://github.com/dromara/hertzbeat/releases) repository
 
-3. Configure HertzBeat's configuration file(optional)        
+2. Configure HertzBeat's configuration file(optional)        
    Unzip the installation package to the host eg: /opt/hertzbeat    
    ``` 
-   $ tar zxvf hertzbeat-[version].tar.gz
+   $ tar zxvf hertzbeat-xx.tar.gz
    or
-   $ unzip -o hertzbeat-[version].zip
+   $ unzip -o hertzbeat-xx.zip
    ```
    Modify the configuration file `hertzbeat/config/application.yml` params according to your needs.      
    - If you need to use email to send alarms, you need to replace the email server parameters `spring.mail` in `application.yml`   
    - **Recommended** If you need to use an external Mysql database to replace the built-in H2 database, you need to replace the `spring.datasource` parameter in `application.yml` For specific steps, see [Using Mysql to replace H2 database](mysql-change)  
    - **Recommended** If you need to use the time series database TDengine to store indicator data, you need to replace the `warehouse.store.td-engine` parameter in `application.yml` for specific steps, see [Using TDengine to store metrics data](tdengine-init)   
    - **Recommended** If you need to use the time series database IotDB to store the indicator database, you need to replace the `warehouse.storeiot-db` parameter in `application.yml` For specific steps, see [Use IotDB to store metrics data](iotdb-init)
 
-4. Configure the account file(optional)     
+3. Configure the account file(optional)     
    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 `hertzbeat/config/sureness.yml`. Ignore this step without this demand.     
    For detail steps, please refer to [Configure Account Password](account-modify)  
 
-5. Start the service   
+4. Start the service   
    Execute the startup script `startup.sh` in the installation directory `hertzbeat/bin/`, or `startup.bat` in windows.   
    ``` 
    $ ./startup.sh 
    ```
 
-⚠️Note, If there are multiple Java environments configured in the system environment variables and `java11` is not included, modify `$ ./startup.sh` or `startup.bat` to specify the Java path manually.  
-In `startup.sh`, add `JAVA_HOME=${JAVA_DIR}` at the first line.    
-In `startup.bat`, modify `javaw` to the path of `java11`, such as `C:\Users\user\.jdks\corretto-11.0.18\bin\javaw`
-
-6. Begin to explore HertzBeat    
+5. Begin to explore HertzBeat    
 
    Access http://localhost:1157/ using browser. You can explore HertzBeat with default account `admin/hertzbeat` now!    
 
-7. Deploy collector clusters (Optional)
+6. Deploy collector clusters (Optional)
 
-   - Download and unzip the collector release package `hertzbeat-collector-xx.zip` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
-   - Also need to install `java jdk11` environment like above.
+   - Download and unzip the collector release package `hertzbeat-collector-xx.tar.gz` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
    - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port`
      ```yaml
      collector:
@@ -77,25 +60,39 @@ In `startup.bat`, modify `javaw` to the path of `java11`, such as `C:\Users\user
 
 ### FAQ  
 
-1. **According to the process deploy，visit http://ip:1157/ no interface**   
+1. **If using the package not contains JDK, you need to prepare the JAVA environment in advance**
+
+   Install JAVA runtime environment-refer to [official website](http://www.oracle.com/technetwork/java/javase/downloads/index.html)    
+   requirement：JDK11 ENV     
+   download JAVA installation package: [mirror website](https://repo.huaweicloud.com/java/jdk/)   
+   After installation use command line to check whether you install it successfully.
+   ```
+   $ java -version
+   java version "11.0.12" 
+   Java(TM) SE Runtime Environment 18.9 (build 11.0.12+8-LTS-237)
+   Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.12+8-LTS-237, mixed mode)
+
+   ```
+
+2. **According to the process deploy，visit http://ip:1157/ no interface**   
    Please refer to the following points to troubleshoot issues:
 > 1：If you switch to dependency service MYSQL database，check whether the database is created and started successfully.
 > 2：Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `hertzbeat/config/application.yml`.    
 > 3：Check whether the running log has errors in `hertzbeat/logs/` directory. If you haven't solved the issue, report it to the communication group or community.
 
-2. **Log an error TDengine connection or insert SQL failed**
+3. **Log an error TDengine connection or insert SQL failed**
 > 1：Check whether database account and password configured is correct, the database is created.   
 > 2：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server.    
 
-3. **Historical monitoring charts have been missing data for a long time**
+4. **Historical monitoring charts have been missing data for a long time**
 > 1：Check whether you configure Tdengine or IoTDB. No configuration means no historical chart data.  
 > 2：Check whether Tdengine database `hertzbeat` is created.
 > 3: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`.
 
-4. **The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed**
+5. **The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed**
 > Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible.
 
-5. **The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database]**
+6. **The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database]**
 > Please check if the configuration parameters are correct  
 > Is iot-db or td-engine enable set to true  
 > Note⚠️If both hertzbeat and IotDB, TDengine are started under the same host for docker containers, 127.0.0.1 cannot be used for communication between containers by default, and the host IP is changed  

diff --git a/home/docs/start/quickstart.md b/home/docs/start/quickstart.md
@@ -39,14 +39,12 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.com/do
 
 ##### 2：Install via package
 
-1. Download the release package `hertzbeat-xx.zip` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
-2. Need `java jdk11` Environment
-3. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional)
-4. Run command `$ ./bin/startup.sh ` or `bin/startup.bat`
-5. Access `http://localhost:1157` to start, default account: `admin/hertzbeat`
-6. Deploy collector clusters
-   - Download the release package `hertzbeat-collector-xx.zip` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
-   - Need `java jdk11` Environment
+1. Download the release package `hertzbeat-xx.tar.gz` [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
+2. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional)
+3. Run command `$ ./bin/startup.sh ` or `bin/startup.bat`
+4. Access `http://localhost:1157` to start, default account: `admin/hertzbeat`
+5. Deploy collector clusters
+   - Download the release package `hertzbeat-collector-xx.tar.gz` to new machine [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
    - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port`
      ```yaml
      collector: