GridGain Developers Hub

GridGain for Node.JS

This chapter explains system requirements for running GridGain, how to install GridGain, start a cluster and run a simple Hello World example using a thin client for Node.js.

Thin Client is a lightweight GridGain connection mode. It does not participate in cluster, never holds any data, or performs computations. All it does is establish a socket connection to an individual GridGain node and perform all operations through that node.

Since GridGain is built on top of Apache Ignite, GridGain reuses Ignite’s system properties, environment properties, startup scripts, etc. wherever possible.


GridGain was officially tested on:


Oracle JDK 8, Open JDK 8, IBM JDK 8


Linux (any flavor), Mac OSX (10.6 and up), Windows (XP and up), Windows Server (2008 and up), Oracle Solaris


x86, x64, SPARC, PowerPC


No restrictions (10G recommended)


Node.js Version 8 or higher is required. Either download the Node.js pre-built binary for the target platform, or install Node.js via package manager.

Installing GridGain

GridGain is available in three editions: Community Edition (CE), Enterprise Edition (EE) and Ultimate Edition (UE). For this example, we’ll use the GridGain CE, which is distributed as binary, docker, and cloud images, and via RPM/DEB. This chapter explains how to install the GridGain CE binary distribution.

To get started with the GridGain CE binary distribution:

  1. Download the GridGain binary as a zip archive.

  2. Unzip the zip archive into the installation folder in your system.

  3. Move the ignite-rest-http folder from {gridgain}/libs/optional to {gridgain}/libs to enable the Ignite REST library for the cluster. The library is used by GridGain Web Console for cluster management and monitoring needs.

  4. (Optional) Enable required modules.

  5. (Optional) Set the IGNITE_HOME environment variable or Windows PATH to point to the installation folder and make sure there is no trailing / (or \ for Windows) in the path.

Once that’s done, execute the following command to install the Node.js Thin Client package:

sudo npm install -g apache-ignite-client
npm install -g apache-ignite-client

And you’ll want to link the examples:

cd {gridgain_dir}/platforms/nodejs/examples
npm link apache-ignite-client

Starting a GridGain Node

Before connecting to GridGain from Node.JS thin client, you must start at least one GridGain cluster node.

You can start a GridGain node from the command line using the default configuration or by passing a custom configuration file. You can start as many nodes as you like and they will all automatically discover each other.

Navigate into the bin folder of GridGain installation directory from the command shell. Your command might look like this:

$ cd {gridgain}/bin/
$ cd {gridgain}\bin\

Start a GridGain node with a custom configuration file that is passed as a parameter to|bat like this:

$ ./ examples/config/example-ignite.xml
$ ignite.bat examples\config\example-ignite.xml

You will see output similar to this:

[08:53:45] Ignite node started OK (id=7b30bc8e)
[08:53:45] Topology snapshot [ver=1, locNode=7b30bc8e, servers=1, clients=0, state=ACTIVE, CPUs=4, offheap=1.6GB, heap=2.0GB]

Open another tab from your command shell and run the same command again:

$ ./ examples/config/example-ignite.xml
$ ignite.bat examples\config\example-ignite.xml

Check the Topology snapshot line in the output. Now you have a cluster of two server nodes with more CPUs and RAM available cluster-wide:

[08:54:34] Ignite node started OK (id=3a30b7a4)
[08:54:34] Topology snapshot [ver=2, locNode=3a30b7a4, servers=2, clients=0, state=ACTIVE, CPUs=4, offheap=3.2GB, heap=4.0GB]

Running Your First GridGain Application

Once the cluster is started, you can use the GridGain Node.js thin client to perform cache operations. Your GridGain CE installation includes several ready-to-run PHP examples in the {gridgain_dir}/platforms/php/examples directory. For example,

cd {gridgain_dir}/platforms/nodejs/examples
node CachePutGetExample.js

Assuming that the server node is running locally, and that you have completed all of the pre-requisites listed above, here is a very simple HelloWorld example that puts and gets values from the cache. If you followed the instructions above, and if you place this hello world example in your examples folder, it should work.

const IgniteClient = require('apache-ignite-client');
const IgniteClientConfiguration = IgniteClient.IgniteClientConfiguration;
const ObjectType = IgniteClient.ObjectType;
const CacheEntry = IgniteClient.CacheEntry;

async function performCacheKeyValueOperations() {
    const igniteClient = new IgniteClient();
    try {
        await igniteClient.connect(new IgniteClientConfiguration(''));
        const cache = (await igniteClient.getOrCreateCache('myCache')).
        // put and get value
        await cache.put(1, 'Hello World');
        const value = await cache.get(1);

    catch (err) {
    finally {


Next Steps

From here, you may want to:

Using GridGain Web Console

GridGain Web Console is an interactive configuration, management, and monitoring tool, built on top of Apache Ignite Web Console.

  1. Go to and create an account.

  2. Log in with your new account and go to the "Monitoring Dashboard" screen. Click the three horizontal lines at the top in order to expand the left-hand menu:

    Web Console Left Nav
  3. Click the "Download Agent" button as shown in the screenshot below:

    Download the Web Console Agent
  4. Extract the web agent into a separate folder.

  5. Navigate to the folder where you extracted the web agent files, and execute the (or ignite-web-agent.bat) script.

  6. Ensure that the agent can connect to both and your single node cluster started earlier. Look for messages similar to the following in the agent’s log:

    Web Console Log
  7. Go back to the Monitoring Dashboard and refresh it. Confirm that the tool successfully displays metrics for your local single node cluster.