This is a prerelease version.

View latest

Install Hazelcast Community Edition

5.7-SNAPSHOT 5.5 5.4 5.3 5.2 5.1 5.0

You can install the Community Edition of Hazelcast using a package manager, Docker, or the binary. Alternatively, you can add Hazelcast as a dependency in your Java project.

These instructions apply only to the Community Edition. If you have an Enterprise Edition license, follow the instructions in Install Hazelcast Enterprise Edition.

We recommend that you learn more about the benefits of an Enterprise Edition license to ensure that you do not require any of the additional functionality or support before you install Community Edition. If you continue with the Community Edition installation, you can move your Community Edition members to Enterprise Edition at any time if you subsequently want to benefit from the Enterprise Edition functionality without downtime.

For further information on the available Enterprise Edition features and on moving members from an Community Edition cluster to a target Enterprise Edition cluster, see Move to Enterprise Edition from Community Edition.

Distributions

Both slim and full distributions are available:

Further information on the available editions and distributions.

Use a package manager

Hazelcast offers package managers for Linux and macOS operating systems.

Package managers are the fastest way to install Hazelcast. This option is for development purposes and is only available for Hazelcast Community Edition. For production, use the other deployment options explained on this page.

  1. To install Hazelcast, use the appropriate command for your operating system:

    • Mac

    • Linux

    • Windows

    To install on macOS, use the Homebrew package manager.

    brew tap hazelcast/hz
brew install [email protected]

    You can use either of these package managers to install Hazelcast, depending on your Linux distribution:

    Debian
    sudo apt-get install -y --no-upgrade wget gpg coreutils \
  && 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.7.0-SNAPSHOT
    RPM
    sudo yum -y install wget \
  && 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.7.0-SNAPSHOT

    Hazelcast does not yet 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 Platform is correctly installed, using the following command:

    hz -V

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

For more information about the packages, see the GitHub repository.

Use Docker

  1. Install Docker.

  2. Check that Docker is correctly installed.

    docker version

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

  3. Pull the latest Docker image

    docker pull hazelcast/hazelcast:5.7.0-SNAPSHOT

Use the binary

Download the latest snapshot archive and extract the binaries.

  • Mac

  • Linux

  • Windows

  1. Download a package from hazelcast.com.

  2. Extract the downloaded package.

  1. Download a package from hazelcast.com.

  2. Extract the downloaded package.

  1. Download a package from hazelcast.com.

  2. Extract the downloaded package.

Use Java

To install Hazelcast with Java, you can use one of the following:

  • Maven

  • JAR file

  • Modular Java

Use Maven

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.

  1. Download and install a supported JDK.

  2. Add the following to your pom.xml file.

    <dependencies>
   <dependency>
       <groupId>com.hazelcast</groupId>
       <artifactId>hazelcast</artifactId> (1)
       <version>5.7.0-SNAPSHOT</version> (2)
   </dependency>
</dependencies>
    1 Hazelcast Community Edition dependency.
    2 Hazelcast Community Edition version.

Use modular Java

You can use Hazelcast as a module in the Java Platform Module System (JPMS).

To run your application with Hazelcast libraries on the module path, use com.hazelcast.core for the hazelcast-5.7.0-SNAPSHOT.jar module name.

If you use JPMS, it enforces stricter visibility rules and Hazelcast uses the internal Java API to reach the best performance results.

Hazelcast needs the java.se module and access to the following Java packages:

  • java.base/jdk.internal.ref

  • java.base/java.nio (reflective access)

  • java.base/sun.nio.ch (reflective access)

  • java.base/java.lang (reflective access)

  • jdk.management/com.ibm.lang.management.internal (reflective access)

  • jdk.management/com.sun.management.internal (reflective access)

  • java.management/sun.management (reflective access)

You can provide access to these packages by using simple --add-exports and --add-opens (for reflective access) Java arguments.

Run a member on the classpath
java --add-modules java.se \
  --add-exports java.base/jdk.internal.ref=ALL-UNNAMED \
  --add-opens java.base/java.lang=ALL-UNNAMED \
  --add-opens java.base/java.nio=ALL-UNNAMED \
  --add-opens java.base/sun.nio.ch=ALL-UNNAMED \
  --add-opens java.management/sun.management=ALL-UNNAMED \
  --add-opens jdk.management/com.ibm.lang.management.internal=ALL-UNNAMED \
  --add-opens jdk.management/com.sun.management.internal=ALL-UNNAMED \
  -jar hazelcast-5.7.0-SNAPSHOT.jar
Run a member on the module path
java --add-modules java.se \
  --add-exports java.base/jdk.internal.ref=com.hazelcast.core \
  --add-opens java.base/java.lang=com.hazelcast.core \
  --add-opens java.base/java.nio=com.hazelcast.core \
  --add-opens java.base/sun.nio.ch=com.hazelcast.core \
  --add-opens java.management/sun.management=com.hazelcast.core \
  --add-opens jdk.management/com.ibm.lang.management.internal=com.hazelcast.core \
  --add-opens jdk.management/com.sun.management.internal=com.hazelcast.core \
  --module-path lib \ (1)
  --module com.hazelcast.core/com.hazelcast.core.server.HazelcastMemberStarter
1 This example requires the hazelcast-5.7.0-SNAPSHOT.jar file in the lib directory.

Next steps

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

lifebuoy

Help and support