A newer version of Platform is available.

View latest

Installing Hazelcast Open Source

You can install the Open Source edition of Hazelcast, using the command line interface (CLI), Docker, the binary, or Java.

Looking for Hazelcast Enterprise? See Installing Hazelcast Enterprise.

Using a Package Manager

Hazelcast offers package managers for Linux and Mac operating systems.

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

    • Mac

    • Linux

    • Windows

    To install on macOS, use the Homebrew package manager.

    brew tap hazelcast/hz
    brew install hazelcast@5.0.5

    To install on Linux, you can use either of these package managers, depending on your Linux distribution:

    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 stable main" | sudo tee -a /etc/apt/sources.list
    sudo apt update && sudo apt install hazelcast=5.0.5
    wget https://repository.hazelcast.com/rpm/stable/hazelcast-rpm-stable.repo -O hazelcast-rpm-stable.repo
    sudo mv hazelcast-rpm-stable.repo /etc/yum.repos.d/
    sudo yum install hazelcast=5.0.5

    At the moment, Hazelcast does not support any Windows package managers.

    To get started with Hazelcast on Windows, you can use Docker, the binary distribution, or Java.

  2. Check that Hazelcast is installed.

    hz -V

    You should the version of both Hazelcast and the command-line client (CLI).

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

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 Hazelcast Docker image from Docker Hub.

    docker pull hazelcast/hazelcast:5.0.5

Using the Binary

Download the archive and extract the binaries.

  • Mac

  • Linux

  • Windows

wget -O - 'https://repository.hazelcast.com/download/hazelcast/hazelcast-5.0.5.tar.gz' | tar xvzf -
wget -O - 'https://repository.hazelcast.com/download/hazelcast/hazelcast-5.0.5.tar.gz' | tar xvzf -

Download and extract the Hazelcast ZIP file.

Using Java

Hazelcast runs on Java, which means you can add it as a dependency in your Java project.

The Java package includes both a member API and a Java client API. The member API is for embedded topologies where you want to deploy and manage a cluster in the same Java Virtual Machine (JVM) as your applications. The Java client is for connecting to an existing member in a client/server topology, such as Hazelcast Cloud Managed Services.

  1. Download and install a supported JDK.

  2. If you’re using Maven, create a new project and add the following to your pom.xml file.

  3. If you aren’t using a build tool, download the Hazelcast JAR file and add it to your classpath.

Next Steps

To continue learning about Hazelcast, start a local cluster, using Docker, the binary, or Java.