Skip to main content
Version: 3.1.0 (Latest)

Install Using ZIP Archive

Prerequisites​

Apache Ignite supports Linux, macOS, and Windows operating systems.

Apache Ignite 3 requires Java 11 or later.

Apache Ignite Package Structure​

Apache Ignite provides 2 archives for distribution:

  • ignite3-db-{version} - this archive contains everything related to the Apache Ignite database. When unpacked, it creates the folder where data will be stored by default. You start Apache Ignite nodes from this folder.
  • ignite3-cli-{version} - this archive contains the Apache Ignite CLI tool. This tool is the main way of interacting with Apache Ignite clusters and nodes.

Installing Apache Ignite Database​

To install the Apache Ignite database, download the database archive from the website and then:

  1. Unpack the archive:
unzip ignite3-db-{version}.zip && cd ignite3-db-{version}
  1. Create the IGNITE_HOME environment variable with the path to the ignite3-db-{version} folder.

Starting the Node​

Once you have unpacked the archive, you can start the Apache Ignite node:

bin/ignite3db

By default, the node loads the etc/ignite-config.conf configuration file on startup. You can update it to customize the node configuration, or change the configuration folder in the etc/vars.env file.

When the node is started, it will enter the cluster if it is already configured and initialized, or will wait for cluster initialization.

Installing Apache Ignite CLI Tool​

The CLI tool is the primary means of working with the Apache Ignite database. It is not necessary to install on every machine that is running Apache Ignite, as you can connect to the node via REST interface.

To install the Apache Ignite CLI, download the database archive from the website and then unpack it:

unzip ignite3-cli-{version}.zip && cd ignite3-cli-{version}

Next Steps​

With Apache Ignite installed, you can proceed with the Getting Started Guide or use the available APIs immediately.