hertzbeat/home/i18n/en/docusaurus-plugin-content-docs/version-v1.1.x/start/package-deploy.md

id, title, sidebar_label

id	title	sidebar_label
package-deploy	Install HertzBeat via Package	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.

1. Install JAVA runtime environment-refer toofficial website
   requirement：JDK11 ENV
   download JAVA installation package: mirror website
   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 corresponding to your system environment

   • download from GITEE Release repository
   • download from GITHUB Release repository

3. Configure HertzBeat's configuration file(optional)
   Unzip the installation package to the host eg: /opt/hertzbeat

   $ tar zxvf hertzbeat-[version number].tar.gz   
   

   Modify the configuration file hertzbeat/config/application.yml Replace warehouse service parameter, IP port account and password Note⚠️（If use email to alert, please replace the mail server parameter. If use MYSQL data source, replace the datasource parameters inside refer toH2 database switch to MYSQL） Specific replacement parameters is as follows:

warehouse:
   store:
      td-engine:
         enabled: true
         driver-class-name: com.taosdata.jdbc.rs.RestfulDriver
         url: jdbc:TAOS-RS://localhost:6041/hertzbeat
         username: root
         password: taosdata
      iot-db:
         enabled: false
         host: 127.0.0.1
         rpc-port: 6667
         username: root
         password: root
         # org.apache.iotdb.session.util.Version: V_O_12 || V_0_13
         version: V_0_13
         # if iotdb version >= 0.13 use default queryTimeoutInMs = -1; else use default queryTimeoutInMs = 0
         query-timeout-in-ms: -1
         # default '7776000000'（90days,unit:ms,-1:no-expire）
         expire-time: '7776000000'
         
spring:
   mail:
      # Attention: this is mail server address.
      host: smtp.exmail.qq.com
      username: example@tancloud.cn
      # Attention: this is not email account password, this requires an email authorization code
      password: example
      port: 465

4. Configure the user configuration file(optional, user-defined user password)
   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. Modify the following part parameters in sureness.yml：[Note⚠️Other default sureness configuration parameters should be retained]

# user account information
# Here is admin tom lili three accounts
# eg: admin includes[admin,user]roles, password is hertzbeat 
# eg: tom includes[user], password is hertzbeat
# eg: lili includes[guest], text password is lili, salt password is 1A676730B0C7F54654B0E09184448289
account:
   - appId: admin
     credential: hertzbeat
     role: [admin,user]
   - appId: tom
     credential: hertzbeat
     role: [user]
   - appId: guest
     credential: hertzbeat
     role: [guest]
 

5. Deploy/Start Execute the startup script startup.sh in the installation directory hertzbeat/bin/

   $ ./startup.sh 
   

6. Begin to explore HertzBeat
   visit http://ip:1157/ on the browser. You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat.

HAVE FUN

FAQ

1. 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

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

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

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]

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
You can check the startup logs according to the logs directory