Skip to content

Commit 863861e

Browse files
authored
docs: added cloud s3 documentation (medusajs#12762)
* docs: added cloud s3 documentation * fixes
1 parent 97d5f52 commit 863861e

File tree

5 files changed

+66
-1
lines changed

5 files changed

+66
-1
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ If you're using a Medusa version before v2.7.0, [contact support](#) for assista
3333

3434
</Note>
3535

36+
### Access Redis Configurations
37+
38+
Since Cloud is a managed service, you can't directly access your Redis instance or its configurations. Cloud also doesn't expose the Redis instance connection or configuration details.
39+
3640
### Override Redis Configurations
3741

3842
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.

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

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
export const metadata = {
2+
title: `S3 Storage`,
3+
}
4+
5+
# {metadata.title}
6+
7+
In this guide, you'll learn about the managed S3 storage service that Cloud provides as part of your project environments.
8+
9+
## Managed S3 Storage Service
10+
11+
Cloud offers a managed S3 storage service for your project environments. Each environment has its own dedicated S3 bucket that is automatically provisioned when the environment is created.
12+
13+
So, when you create a new project, Cloud creates a production S3 bucket for the production environment. If you create a staging environment, Cloud creates a separate S3 bucket for that environment as well.
14+
15+
By default, the S3 bucket is private, but the files you upload to the bucket are publicly accessible. This is necessary for serving product images and other assets in your Medusa application.
16+
17+
![Diagram showcasing S3 isolation between environments](https://res.cloudinary.com/dza7lstvk/image/upload/v1750230909/Cloud/s3-cloud_smrtfc.jpg)
18+
19+
---
20+
21+
## Configured S3 File Module Provider
22+
23+
Cloud automatically configures your Medusa application to use the [S3 File Module Provider](!resources!/infrastructure-modules/file/s3).
24+
25+
So, you don't need to configure the S3 File Module Provider or set up S3 manually. Also, if you have the S3 File Module Provider configured in `medusa-config.ts`, remove it to avoid conflicts.
26+
27+
<Note>
28+
29+
If you're using a Medusa version before v2.7.0, [contact support](#) for assistance in configuring the S3 File Module Provider.
30+
31+
</Note>
32+
33+
### Access S3 Configurations
34+
35+
Since Cloud is a managed service, you can't directly access your S3 bucket or its configurations. Cloud also doesn't expose the S3 bucket connection or configuration details.
36+
37+
### Override S3 Configurations
38+
39+
If you need to override the default S3 configurations, such as changing public access to assets, you can do so by setting up and managing your own S3 bucket externally.
40+
41+
Then, configure the S3 File Module Provider in your `medusa-config.ts` file to connect to your external S3 instance. Refer to the [S3 File Module Provider documentation](!resources!/infrastructure-modules/file/s3) for more details on how to configure it.
42+
43+
<Note title="Tip">
44+
45+
To set the connection options of your external S3 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 S3 instance.
46+
47+
</Note>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ export const generatedEditDates = {
77
"app/organizations/page.mdx": "2025-06-17T10:48:50.969Z",
88
"app/notifications/page.mdx": "2025-06-17T12:29:18.819Z",
99
"app/database/page.mdx": "2025-06-17T14:34:57.104Z",
10-
"app/redis/page.mdx": "2025-06-18T06:50:30.705Z"
10+
"app/redis/page.mdx": "2025-06-18T06:50:30.705Z",
11+
"app/s3/page.mdx": "2025-06-18T07:16:14.453Z"
1112
}

www/apps/cloud/generated/sidebar.mjs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,14 @@ export const generatedSidebars = [
7777
"title": "Redis",
7878
"path": "/redis",
7979
"children": []
80+
},
81+
{
82+
"loaded": true,
83+
"isPathHref": true,
84+
"type": "link",
85+
"title": "S3",
86+
"path": "/s3",
87+
"children": []
8088
}
8189
]
8290
},

www/apps/cloud/sidebar.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ export const sidebar = [
5454
title: "Redis",
5555
path: "/redis",
5656
},
57+
{
58+
type: "link",
59+
title: "S3",
60+
path: "/s3",
61+
},
5762
],
5863
},
5964
{

0 commit comments

Comments
 (0)