{
  "id": "install",
  "title": "Install RedisGears and the JVM plugin",
  "url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install/",
  "summary": "",
  "tags": [
    "docs",
    "operate",
    "stack"
  ],
  "last_updated": "2026-04-22T11:55:45+02:00",
  "page_type": "content",
  "content_hash": "5247773c24c8f9a35027ab96a1d6807cf8685569b81f60592bc8b786cec2815b",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "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."
    },
    {
      "id": "prerequisites",
      "title": "Prerequisites",
      "role": "content",
      "text": "1. Redis Software v6.0.12 or later\n\n1. [Created a Redis Software cluster](https://redis.io/docs/latest/operate/rs/clusters/new-cluster-setup)\n\n1. [Added nodes to the cluster](https://redis.io/docs/latest/operate/rs/clusters/add-node)\n\n1. [Installed RedisGears and the JVM plugin](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears#install-redisgears)"
    },
    {
      "id": "enable-redisgears-for-a-database",
      "title": "Enable RedisGears for a database",
      "role": "content",
      "text": "1. From the Redis Software admin console's **databases** page, select the **Add** button to create a new database:\n\n    ![images/rs/icon_add.png](https://redis.io/docs/latest/images/rs/icon_add.png)\n\n1. Confirm that you want to create a new Redis database with the **Next** button.\n\n1. On the **create database** page, give your database a name.\n\n1. For **Redis Modules**, select the **Add** button and choose RedisGears from the **Module** dropdown list.\n\n1. Select **Add Configuration**, enter `Plugin gears_jvm` in the box, then select the **OK** button:\n\n    ![images/rs/icon_save.png](https://redis.io/docs/latest/images/rs/icon_save.png)\n\n    \nYou can configure additional JVM options in this box. For example:<br></br>\n`Plugin gears_jvm JvmOptions `<nobr>`'-Dproperty1=value1`</nobr> <nobr>`-Dproperty2=value2'`</nobr>\n    \n\n1. Select the **Activate** button."
    },
    {
      "id": "verify-the-install",
      "title": "Verify the install",
      "role": "content",
      "text": "Run the `RG.JSTATS` command from a database shard to view statistics and verify that you set up RedisGears and the JVM plugin correctly:\n\n[code example]"
    }
  ],
  "examples": [
    {
      "id": "verify-the-install-ex0",
      "language": "sh",
      "code": "$ shard-cli 3\n172.16.0.1:12345> RG.JSTATS",
      "section_id": "verify-the-install"
    }
  ]
}