Install

Before you can use RedisGears with the JVM, you need to install the RedisGears module and JVM plugin on your Redis Software cluster and enable them for a database.

Prerequisites

1. Redis Software v6.0.12 or later

2. [Created a Redis Software cluster]({{< relref "/operate/rs/clusters/new-cluster-setup" >}})

3. [Added nodes to the cluster]({{< relref "/operate/rs/clusters/add-node" >}})

4. [Installed RedisGears and the JVM plugin]({{< relref "/operate/oss_and_stack/stack-with-enterprise/gears-v1/installing-redisgears#install-redisgears" >}})

Enable RedisGears for a database

1. From the Redis Software admin console's databases page, select the Add button to create a new database:

   {{<image filename="images/rs/icon_add.png" width="30px" alt="The Add icon">}}

2. Confirm that you want to create a new Redis database with the Next button.

3. On the create database page, give your database a name.

4. For Redis Modules, select the Add button and choose RedisGears from the Module dropdown list.

5. Select Add Configuration, enter Plugin gears_jvm in the box, then select the OK button:

   {{<image filename="images/rs/icon_save.png" width="30px" alt="The Save icon">}}

   {{<note>}} You can configure additional JVM options in this box. For example:

   </br>

Plugin gears_jvm JvmOptions <nobr>'-Dproperty1=value1</nobr> <nobr>-Dproperty2=value2'</nobr> {{</note>}}

1. Select the Activate button.

Verify the install

Run the RG.JSTATS command from a database shard to view statistics and verify that you set up RedisGears and the JVM plugin correctly:

$ shard-cli 3
172.16.0.1:12345> RG.JSTATS