Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Node.js

Install GridGain, start a cluster, and run a simple Hello World example using the Node.js thin client.

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.

Prerequisites

This section describes the platform requirements for machines running GridGain. GridGain system requirements scale depending on the size of the cluster.

Requirement
Details

JDK

Oracle JDK 17 or later

OS

Linux (any flavor), Windows (10 and up). For Docker environment, we provide Linux docker containers.

ISA

x86-64, SPARC, PowerPC

Network

No restrictions (10G recommended)

and:

Software
Requirement

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.

(Optional) Open Ports

Depending on your environment and what your plan is, you may want to open additional ports. GridGain uses the following ports:

  • 47100-47200 — ports used by GridGain nodes to communicate. Specific ports used depend on node configuration.

  • 47500-47600 — ports used by GridGain nodes to discover other nodes in the network. Specific ports used depend on node configuration.

  • 10800 — the port used for thin clients, JDBC and ODBC connections.

  • 8080 — the port used for REST API.

  • 11211 — the port used by control script calls. This port should only be opened on nodes that need to send control script messages to other nodes.

Installing GridGain

GridGain is distributed as binary, docker, and cloud images, and via RPM/DEB. This chapter explains how to install the binary distribution.

To get started with the GridGain 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 Control Center 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:

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:

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

You will see output similar to this:

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

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:

By default, ignite.sh|bat starts a node with the default configuration file: config/default-config.xml.

Running Your First GridGain Application

Once the cluster is started, you can use the GridGain Node.js Thin Client to perform cache operations. ZIP installation of Node.js Thin Client includes several ready-to-run examples in the {client_dir}/examples directory. Here is example how to run one of them:

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.

Next Steps

From here, you may want to:

This page is: Copyright © 2026 MariaDB. All rights reserved.

Last updated

Was this helpful?