{
"id": "installing-redisgears",
"title": "Install RedisGears",
"url": "https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/installing-redisgears/",
"summary": "",
"tags": [
"docs",
"operate",
"stack"
],
"last_updated": "2026-04-22T11:55:45+02:00",
"page_type": "content",
"content_hash": "dc9eddaa47adcd4f38231b959da516d6d5eb74ebf855e793ac767712da31ed79",
"sections": [
{
"id": "overview",
"title": "Overview",
"role": "overview",
"text": "Before you can use RedisGears, you have to install the RedisGears module on your Redis Software cluster."
},
{
"id": "minimum-requirements",
"title": "Minimum requirements",
"role": "content",
"text": "- Redis Software 6.0.12 or later\n- The [cluster is setup](https://redis.io/docs/latest/operate/rs/clusters/new-cluster-setup) and all of the nodes are joined to the cluster"
},
{
"id": "install-redisgears",
"title": "Install RedisGears",
"role": "setup",
"text": "If your cluster uses Redis Software v6.0.12 or later and has internet access, you only need to download the RedisGears package. It automatically fetches dependencies like the Python and JVM plugins during online installation.\n\nOffline installation requires you to manually upload dependencies to the primary node."
},
{
"id": "install-redisgears-and-dependencies",
"title": "Install RedisGears and dependencies",
"role": "setup",
"text": "1. Download the **RedisGears** package from the Redis Software [download center](https://cloud.redis.io/#/rlec-downloads).\n\n \nFor offline installation of RedisGears v1.2 and later, you also need to download the **RedisGears Dependencies** packages for both Python and Java.\n
\nFor RedisGears v1.0, you only need the Python dependency package.\n \n\n1. Upload the RedisGears package to a node in the cluster.\n\n1. For offline installation only, copy the dependencies to the primary node.\n\n \nSkip this step unless your cluster does not have internet access.\n \n\n 1. For versions 7.2.4 and later, copy the dependencies to `$modulesdatadir/rg////deps/`:\n\n [code example]\n\n 1. For versions 6.4.2 and earlier, copy the dependencies to `$modulesdatadir/rg//deps/`:\n \n [code example]\n\n Replace these fields with your own values:\n\n - ``: the operating system running Redis Software\n - ``: the RedisGears version `(x.y.z)`\n - ``: the RedisGears version as an integer, calculated as `(x*10000 + y*100 + z)`\n\n For example, the `` for RedisGears version 1.2.5 is 10205.\n\n - ``: the operating system's name\n - ``: the node's architecture\n\n1. Add RedisGears to the cluster with a `POST` request to the primary node's [`/v2/modules`](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/modules#post-module-v2) REST API endpoint:\n\n [code example]\n\nHere, the *module* parameter specifies the full path of the module package and must be submitted as form-data. In addition, the package must be available and accessible to the server processing the request.\n\nAfter the install is complete, RedisGears will appear in the list of available modules on the **settings** and **create database** pages of the Redis Software admin console."
},
{
"id": "enable-redisgears-for-a-database",
"title": "Enable RedisGears for a database",
"role": "content",
"text": "After installation, create a new database and enable RedisGears:\n\n- [With Python](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/python/install)\n\n- [With the JVM](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/deprecated-features/gears-v1/jvm/install)"
},
{
"id": "upgrade-redisgears-for-existing-databases",
"title": "Upgrade RedisGears for existing databases",
"role": "content",
"text": "To upgrade RedisGears for an existing database after installing a new version, use [`rladmin upgrade db`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/upgrade#upgrade-db):\n\n[code example]\n\nThe following example shows how to upgrade a database named `shopping-cart` to RedisGears version 1.2.9 without changing its configuration:\n\n[code example]\n\n\nThese command examples also upgrade the database to the latest Redis version on the cluster. For more module upgrade information and examples, see [Upgrade modules](https://redis.io/docs/latest/operate/oss_and_stack/stack-with-enterprise/install/upgrade-module)."
},
{
"id": "uninstall-redisgears",
"title": "Uninstall RedisGears",
"role": "content",
"text": "To uninstall RedisGears, make a [`DELETE` request to the `/v2/modules` REST API endpoint](https://redis.io/docs/latest/operate/rs/references/rest-api/requests/modules#delete-module-v2)."
}
],
"examples": [
{
"id": "install-redisgears-and-dependencies-ex0",
"language": "sh",
"code": "cp redisgears-jvm...tgz $modulesdatadir/rg////deps/",
"section_id": "install-redisgears-and-dependencies"
},
{
"id": "install-redisgears-and-dependencies-ex1",
"language": "sh",
"code": "cp redisgears-jvm...tgz $modulesdatadir/rg//deps/",
"section_id": "install-redisgears-and-dependencies"
},
{
"id": "install-redisgears-and-dependencies-ex2",
"language": "sh",
"code": "POST https://[host][:port]/v2/modules\n {\"module=@/tmp/redisgears...zip\"}",
"section_id": "install-redisgears-and-dependencies"
},
{
"id": "upgrade-redisgears-for-existing-databases-ex0",
"language": "sh",
"code": "rladmin upgrade db and module module_name rg version module_args \"\"",
"section_id": "upgrade-redisgears-for-existing-databases"
},
{
"id": "upgrade-redisgears-for-existing-databases-ex1",
"language": "sh",
"code": "rladmin upgrade db shopping-cart and module module_name rg version 10209 module_args keep_args",
"section_id": "upgrade-redisgears-for-existing-databases"
}
]
}