Skip to main content
Version: 5.12

Install and start Management Center

You can install Management Center, using Docker, a package manager, or the binary distribution.

Before you begin​

Hazelcast Management Center requires Java 17 or later to run.

Review the requirements to make sure that you meet them.

Use Docker​

Deploying via Docker is a convenient way to evaluate the latest version of Management Center:

  1. Install Docker.

  2. Check that Docker is correctly installed.

    bash
    docker version

  3. If you do not see a version number, see the Docker docs for troubleshooting information.

  4. Pull the Management Center Docker image from Docker Hub.

    bash
    docker pull hazelcast/management-center:5.12.1

  5. Start the Management Center service.

    shell
    docker run --rm -p 8080:8080 hazelcast/management-center:5.12.1

In some cases, such as querying maps that contain custom objects, you may need to add those object classes to the classpath of Management Center before starting it. To add your own classes to the classpath, you can do one of the following:

  • Pass the MC_CLASSPATH environment variable the paths to your classes, separated by a semicolon.
  • Put your classes in the bin/user-lib/ directory, and mount that directory to the Docker container.

You can find more details on DockerHub.

To start Management Center with a valid Enterprise Edition license, you can pass the environment variable MC_LICENSE:

shell
docker run --rm -p 8080:8080 -e MC_LICENSE=<your-licence-key> hazelcast/management-center:5.12.1

Use a package manager​

Hazelcast offers package managers for Linux and Mac operating systems.

  1. To install Management Center, use one of the following methods, depending on your operating system:

    To install on macOS, use the Homebrew package manager.

    bash
    brew tap hazelcast/hz
    brew trust hazelcast/hz
    brew install hazelcast/hz/[email protected]

  2. Check that Management Center is installed.

    shell
    hz-mc -V

    You should see the version of Management Center.

For more information about the package manager, see the GitHub repository.

Use binary packages​

Hazelcast Management Center is included in the Hazelcast Platform download package.

When a new version of Hazelcast Platform is released, it comes with a compatible version of Management Center. You can download Hazelcast Platform from the download page of the Hazelcast website.

If a new version of Management Center is released before a new version of Hazelcast Platform, you can download the new version as a separate package from the download page.

To start Management Center from the binary package, use the scripts that come with the download package.

note

You cannot use Management Center as a library. Management Center runs as a standalone web application.

You can preconfigure a cluster connection in Management Center by setting the following environment variables:

  • MC_DEFAULT_CLUSTER_MEMBERS—this should contain a comma-separated list of the cluster member addresses.
  • MC_DEFAULT_CLUSTER—this should contain the cluster name, and defaults to dev if not provided.

The recommended way to start Management Center with the binary package is the built-in start scripts in the bin/ directory. A script is available as a batch file for Windows or a shell script for Mac and Linux.

You can start this file from the command line using the following command:

bash
hz-mc start

Provide an extra classpath​

In some cases, such as querying maps that contain custom objects, you may need to add those object classes to the classpath of Management Center before starting it. To add your own classes to the classpath, do one of the following:

  • Pass the MC_CLASSPATH environment variable the paths to your classes, separated by semicolons.
  • Put your classes in the bin/user-lib/ directory.
bash
export MC_CLASSPATH="/path/to/an/extra.jar:/path/to/an/otherextra.jar"
hz-mc start

Starting Management Center with an Enterprise license​

If you want to start Management Center with a valid Enterprise Edition license via the command line, you can set the MC_LICENSE or pass the Java property hazelcast.mc.license environment variable (see hazelcast.mc.license property for more details).

bash
export MC_LICENSE=<license-key>
hz-mc start

or

bash
hz-mc start -Dhazelcast.mc.license=<license key>

Alternatively, you can set the license via the UI as documented in the Enterprise licenses section.

Stop Management Center via the command line​

The following command stops all Management Center processes that are started with either hz-mc start or mc-start.cmd commands:

bash
hz-mc stop
note

These commands stop Management Center processes that have exactly the same version as the script. If you have multiple versions of Management Center running, you need to stop each version using its corresponding script.

Snapshot versions​

Development versions of an upcoming release are available as snapshots. To use the most recent snapshot version of Management Center, do the following:

  • Docker:

    bash
    docker run --rm -p 8080:8080 --pull=always hazelcast/management-center:latest-snapshot

  • Binary packages:

  • Package managers:

    • Homebrew

      bash
      brew tap hazelcast/hz
      brew install hazelcast-management-center@latest-snapshot

    • Linux

      Debian
      shell
      wget -qO - https://repository.hazelcast.com/api/gpg/key/public | gpg --dearmor | sudo tee /usr/share/keyrings/hazelcast-archive-keyring.gpg > /dev/null
      echo "deb [signed-by=/usr/share/keyrings/hazelcast-archive-keyring.gpg] https://repository.hazelcast.com/debian snapshot main"| sudo tee -a /etc/apt/sources.list
      sudo apt update && sudo apt install hazelcast-management-center
      RPM
      shell
      wget https://repository.hazelcast.com/rpm/snapshot/hazelcast-rpm.repo -O hazelcast-snapshot-rpm.repo
      sudo mv hazelcast-snapshot-rpm.repo /etc/yum.repos.d/
      sudo yum install hazelcast-management-center

When you use a snapshot version, it can be useful to query the build information to be able to tell what revision you are using. You can find version metadata about a running instance of Management Center at the following endpoint: <hazelcast.mc.home>/api/buildInfo. This endpoint returns JSON.

Next steps​

For guidance on how to get up and running quickly, see Get Started with Management Center Using Docker Compose.

To learn how to connect to a cluster, see Cluster connections.

To serve Management Center over HTTPS instead of HTTP, see Serve Management Center over HTTPS.

For information about the options you can provide when starting Management Center, see System properties and environment variables.

Enterprise topics

To explore the licensed features of Management Center, see:

For the Management Center features that rely on your cluster's enterprise capabilities, see:

Edit this page