docs: add redis prerequisite for Caching Module (#14051)

* docs: add redis prerequisite for Caching Module

* fix vale error
This commit is contained in:
Shahed Nasser
2025-11-17 09:16:42 +02:00
committed by GitHub
parent 76fd6d1438
commit 2c61a413dc
2 changed files with 17 additions and 8 deletions

View File

@@ -1,4 +1,4 @@
import { CardList, Card, Table, CodeTabs, CodeTab } from "docs-ui"
import { CardList, Card, Table, CodeTabs, CodeTab, Prerequisites } from "docs-ui"
export const metadata = {
title: `Caching Module`,
@@ -8,6 +8,12 @@ export const metadata = {
In this guide, you'll learn about the Caching Module and its providers.
<Note title="Cloud user?">
Refer to the [Medusa Cache Cloud](!cloud!/cache) guide for setting up the Caching Module in Cloud.
</Note>
<Note>
The Caching Module is available starting [Medusa v2.11.0](https://github.com/medusajs/medusa/releases/tag/v2.11.0). It replaces the deprecated [Cache Module](../cache/page.mdx).
@@ -34,14 +40,17 @@ If you're using the Cache Module in your application, refer to the [migrate to t
## Install the Caching Module
<Prerequisites
items={[
{
text: "Redis installed and Redis server running",
link: "https://redis.io/docs/getting-started/installation/"
}
]}
/>
The Caching Module is installed by default in your application. To use it, enable the caching feature flag and register the module in your `medusa-config.ts` file.
{/* <Note title="Cloud user?">
Caching features are enabled by default for Cloud users. Learn more in the [Medusa Cache](!cloud!/cache) guide.
</Note> */}
### 1. Enable Caching Feature Flag
The caching feature is currently behind a feature flag. To enable it, set the `MEDUSA_FF_CACHING` environment variable to `true` in your `.env` file:

View File

@@ -6615,7 +6615,7 @@ export const generatedEditDates = {
"app/how-to-tutorials/tutorials/agentic-commerce/page.mdx": "2025-10-09T11:25:48.831Z",
"app/storefront-development/production-optimizations/page.mdx": "2025-10-03T13:28:37.909Z",
"app/how-to-tutorials/tutorials/category-images/page.mdx": "2025-11-07T08:55:59.228Z",
"app/infrastructure-modules/caching/page.mdx": "2025-10-13T11:46:36.452Z",
"app/infrastructure-modules/caching/page.mdx": "2025-11-13T14:18:03.173Z",
"app/troubleshooting/subscribers/not-working/page.mdx": "2025-10-16T09:25:57.376Z",
"references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.create/page.mdx": "2025-10-21T08:10:56.630Z",
"references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.delete/page.mdx": "2025-10-21T08:10:56.634Z",