Redis Cache Module

The Redis Cache Module uses Redis to cache data in your store. In production, it's recommended to use this module.

---

Register the Redis Cache Module#

Prerequisites1

Redis installed and Redis server running↗

Add the module into the modules property of the exported object in medusa-config.ts:

medusa-config.ts
1import { Modules } from "@medusajs/framework/utils"2
3// ...4
5module.exports = defineConfig({6  // ...7  modules: [8    {9      resolve: "@medusajs/medusa/cache-redis",10      options: { 11        redisUrl: process.env.CACHE_REDIS_URL,12      },13    },14  ],15})

Environment Variables#

Make sure to add the following environment variables:

Terminal
❯CACHE_REDIS_URL=<YOUR_REDIS_URL>

Redis Cache Module Options#

Option	Description	Required	Default
redisUrl	A string indicating the Redis connection URL.	Yes	-
redisOptions	An object of Redis options. Refer to the Redis API Reference for details on accepted properties.	No	-
ttl	The number of seconds an item can live in the cache before it’s removed.	No	30 seconds
namespace	A string used to prefix all cached keys with {namespace}:.	No	medusa. So, all cached keys are prefixed with medusa:.

---

Test the Module#

To test the module, start the Medusa application:

npm
yarn
pnpm

You'll see the following message in the terminal's logs:

Terminal
❯Connection to Redis in module 'cache-redis' established

Edit this page