Install HertzBeat via Docker Compose

Apache HertzBeat Quickstart Part 2 DevOps Docs

Install HertzBeat via Docker Compose

This guide explains how to install and deploy HertzBeat using Docker Compose. It assumes that Docker and Docker Compose are already installed in your environment. If not, refer to the Docker Compose official documentation for installation instructions. Use the command docker compose version to confirm the Docker Compose environment is properly set up.

Steps to Install HertzBeat via Docker Compose

1. Download the startup script package

Download the installation script package apache-hertzbeat-xxx-incubating-docker-compose.tar.gz from the download

2. Choose Deployment: HertzBeat + PostgreSQL + VictoriaMetrics

  • apache-hertzbeat-xxx-incubating-docker-compose.tar.gz contains multiple deployment solutions after decompression. Here we recommend choosing the hertzbeat-postgresql-victoria-metrics solution.

  • Other deployment methods, please read the README.md file of each deployment solution in detail.

  • If using the MySQL solution, ensure you manually download and prepare the MySQL driver package.

Steps to Deploy HertzBeat with PostgreSQL and VictoriaMetrics:

1. Unzip the Script Package

Extract the contents of the downloaded .tar.gz file:

tar zxvf apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz

2. Navigate to the Deployment Directory

Change to the directory for the HertzBeat + PostgreSQL + VictoriaMetrics deployment:

cd apache-hertzbeat-1.6.0-incubating-docker-compose    
cd hertzbeat-postgresql-victoria-metrics

3. One-click start

Run the following command to start the services:

docker-compose up -d

4. View service status

Check the status of each container to ensure they are running. Containers in the up state indicate successful deployment:

docker-compose ps

3. Start exploring HertzBeat

Once all containers are running, access HertzBeat’s web UI by navigating to the following URL in your browser:

  • Default Credentials:
    • Username: admin
    • Password: hertzbeat

You can now start monitoring and using the powerful features of HertzBeat!

Troubleshooting

Common Issues:

  • Docker Compose Not Installed If docker compose version fails, install Docker Compose using the official guide .

  • Ports Already in Use If port 1157 is occupied, update the docker-compose.yml file to map to an available port on your host.

  • Containers Not Starting Use the docker-compose logs command to view logs and troubleshoot errors.

Additional Resources