Skip to content

Commit 97d5f52

Browse files
authored
docs: added cloud redis documentation (medusajs#12760)
* docs: added cloud redis documentation * small fix * add diagram * small fixes
1 parent 5856963 commit 97d5f52

File tree

4 files changed

+61
-1
lines changed

4 files changed

+61
-1
lines changed

www/apps/cloud/app/redis/page.mdx

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
export const metadata = {
2+
title: `Redis`,
3+
}
4+
5+
# {metadata.title}
6+
7+
In this guide, you'll learn about the managed Redis service that Cloud provides as part of your project environments.
8+
9+
## Managed Redis Service
10+
11+
Cloud offers a managed Redis service for your project environments. Each environment has its own dedicated Redis instance that is automatically provisioned when the environment is created.
12+
13+
So, when you create a new project, Cloud creates a production Redis instance for the production environment. If you create a staging environment, Cloud creates a separate Redis instance for that environment as well.
14+
15+
![Diagram showcasing Redis isolation between environments](https://res.cloudinary.com/dza7lstvk/image/upload/v1750230910/Cloud/redis-cloud_llg83c.jpg)
16+
17+
---
18+
19+
## Configured Redis Infrastructure Modules
20+
21+
Cloud automatically configures your Medusa application to use Redis-based Infrastructure Modules, including:
22+
23+
- [Redis Event Module](!resources!/infrastructure-modules/event/redis)
24+
- [Redis Cache Module](!resources!/infrastructure-modules/cache/redis)
25+
- [Redis Locking Module Provider](!resources!/infrastructure-modules/locking/redis)
26+
- [Redis Workflow Engine Module](!resources!/infrastructure-modules/workflow-engine/redis)
27+
28+
So, you don't need to configure any of these modules and providers or set up Redis manually. Also, if you have them configured in `medusa-config.ts`, remove them to avoid conflicts.
29+
30+
<Note>
31+
32+
If you're using a Medusa version before v2.7.0, [contact support](#) for assistance in configuring the Redis modules.
33+
34+
</Note>
35+
36+
### Override Redis Configurations
37+
38+
If you need to customize the Redis configurations for any of the Redis modules and providers, you must host and manage your own Redis instance externally.
39+
40+
Then, configure the modules and providers you're overriding in your `medusa-config.ts` file to connect to your external Redis instance. Refer to the documentation for each module for more details on how to configure it.
41+
42+
<Note title="Tip">
43+
44+
To set the connection URL of your external Redis instance, refer to the [Environments](../environments/page.mdx#add-environment-variables) guide to learn how to add environment variables. You can then use these variables in your `medusa-config.ts` file to connect to your Redis instance.
45+
46+
</Note>

www/apps/cloud/generated/edit-dates.mjs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ export const generatedEditDates = {
66
"app/deployments/page.mdx": "2025-06-17T11:17:03.236Z",
77
"app/organizations/page.mdx": "2025-06-17T10:48:50.969Z",
88
"app/notifications/page.mdx": "2025-06-17T12:29:18.819Z",
9-
"app/database/page.mdx": "2025-06-17T14:34:57.104Z"
9+
"app/database/page.mdx": "2025-06-17T14:34:57.104Z",
10+
"app/redis/page.mdx": "2025-06-18T06:50:30.705Z"
1011
}

www/apps/cloud/generated/sidebar.mjs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,14 @@ export const generatedSidebars = [
6969
"title": "Database",
7070
"path": "/database",
7171
"children": []
72+
},
73+
{
74+
"loaded": true,
75+
"isPathHref": true,
76+
"type": "link",
77+
"title": "Redis",
78+
"path": "/redis",
79+
"children": []
7280
}
7381
]
7482
},

www/apps/cloud/sidebar.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ export const sidebar = [
4949
title: "Database",
5050
path: "/database",
5151
},
52+
{
53+
type: "link",
54+
title: "Redis",
55+
path: "/redis",
56+
},
5257
],
5358
},
5459
{

0 commit comments

Comments
 (0)