This is a prerelease version.

View latest

Installing and Starting Management Center

This topic explains the options for installing and starting Management Center, using Docker or the binary packages.

Before you Begin

Review the requirements and make sure that you meet them.

Using Docker

  1. Install Docker.

  2. Check that Docker is correctly installed.

    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.

    docker pull hazelcast/management-center:5.1-SNAPSHOT
  5. Start the Management Center service

    docker run --rm -p 8080:8080 hazelcast/management-center:5.1-SNAPSHOT

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.

Please see more details at DockerHub.

Using 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, you have the following options:

  • Use the JAR file.

  • Use the scripts that come with the download package.

  • Deploy the WAR file on your Java application’s server/servlet container.

For all the starting options you can preconfigure a cluster in Management Center by setting the following environment variables:

  • MC_DEFAULT_CLUSTER_MEMBERS variable should contain a comma-separated list of the cluster member addresses.

  • MC_DEFAULT_CLUSTER variable should contain the cluster name and defaults to dev if not provided.

Using Start Script

The recommended way to start Management Center with the binary package is the built-in mc-start script in the bin/ directory. This 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:

  • Linux and Mac

  • Windows

hz-mc start
mc-start.cmd

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

  • Put your classes in the bin/user-lib/ directory.

  • Linux and Mac

  • Windows

export MC_CLASSPATH="/path/to/an/extra.jar:/path/to/an/otherextra.jar"
hz-mc start
SET MC_CLASSPATH="/path/to/an/extra.jar;/path/to/an/otherextra.jar"
mc-start.cmd

Using the JAR File

The download package contains a hazelcast-management-center-5.1-SNAPSHOT.jar file, which you can execute directly from the command line using the following command.

Some environment variables do not work with the JAR file. We recommend using the script.
java -jar hazelcast-management-center-5.1-SNAPSHOT.jar

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 the following:

  • Linux and Mac

  • Windows

java -cp "hazelcast-management-center-5.1-SNAPSHOT.jar:/path/to/an/extra.jar" com.hazelcast.webmonitor.Launcher
java -cp "hazelcast-management-center-5.1-SNAPSHOT.jar;/path/to/an/extra.jar" com.hazelcast.webmonitor.Launcher

Deploying to an Application Server

The download package contains a hazelcast-management-center-5.1-SNAPSHOT.war file, which you can deploy on your application server, such as Tomcat or Jetty.

SNAPSHOT versions

Development versions of an upcoming release are available as snapshots. To use the most recent snapshot version of Management Center, use the latest-snapshot tag in Docker:

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

Alternatively, you can download the latest snapshot package: - Download ZIP - Download TAR

In these cases, 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 an end-to-end getting started, see Get Started with Management Center in Docker.

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 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 the following:

See also the following for the Management Center features that rely on your cluster’s enterprise capabilities: