본문으로 건너뛰기
버전: dev

Install HertzBeat via Docker Compose

Suggest to use Docker Compose to deploy HertzBeat and its dependent services.

참고

This document assumes that you already have Docker and Docker Compose installed in your environment. If not, please refer to the Docker official documentation. Run the docker compose version command to check if you have a Docker Compose environment.

  1. Download the startup script package

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

  2. Choose to use the HertzBeat + PostgreSQL + VictoriaMetrics solution

    • apache-hertzbeat-${version}-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. The MySQL solution requires you to prepare the MySQL driver package yourself.
    • Unzip the script package
    tar zxvf apache-hertzbeat-${version}-docker-compose.tar.gz
    • Enter the decompression directory and select HertzBeat + PostgreSQL + VictoriaMetrics for one-click deployment
    cd apache-hertzbeat-${version}-docker-compose
    cd hertzbeat-postgresql-victoria-metrics
    • Create the .env file and set the database password

    POSTGRES_PASSWORD is required. docker compose up refuses to start without it.

    cp .env.example .env
    # Edit .env and set POSTGRES_PASSWORD to a strong password of your own
    • One-click start

    Run script in hertzbeat-postgresql-victoria-metrics directory

    docker-compose up -d
    • View service status

      View the running status of each container, up is the normal running status

      docker-compose ps
  3. Start exploring HertzBeat Access http://localhost:1157/ in the browser to start exploring and using it. The default account password is admin/hertzbeat.

    참고

    The quick-start stack publishes every host port on 127.0.0.1 by default, so the web UI is reachable only from the machine running Docker. To open it to other hosts, set HERTZBEAT_BIND_ADDRESS in .env to an address those hosts can reach (a TLS reverse proxy is preferred over a wildcard address such as 0.0.0.0), then run docker compose config to inspect the final port bindings and restart with docker compose up -d.

    This setting also opens 1158 for remote Collectors; 14317 (OTLP/gRPC) is controlled separately by HERTZBEAT_OTLP_BIND_ADDRESS. See the README.md of the deployment solution for details.

HAVE FUN


FAQ

The most common problem is network problems, please check in advance