Skip to content

Commit 528adf0

Browse files
authored
docs: add S3 info, storefront runtime, and guide on renaming repos for Cloud (#14908)
1 parent 0042779 commit 528adf0

File tree

8 files changed

+100
-17
lines changed

8 files changed

+100
-17
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ To get the read-only connection string for an environment's database:
4343
1. From the [organization's dashboard](../organizations/page.mdx), click on the environment's project.
4444
2. In the project's dashboard, click on the name of the environment. For example, "Production".
4545
3. In the environment's dashboard, click on the "Settings" tab.
46-
4. Choose the "Database" tab from the sidebar.
47-
5. Copy the read-only connection string in the code block.
46+
4. Choose the "Storage" tab from the sidebar.
47+
5. In the "Database connection string" section, copy the read-only connection string in the code block.
4848

49-
![Read-only connection string in Database settings](https://res.cloudinary.com/dza7lstvk/image/upload/v1755271713/Cloud/CleanShot_2025-08-15_at_18.27.58_2x_fqlync.png)
49+
![Read-only connection string in Storage settings](https://res.cloudinary.com/dza7lstvk/image/upload/v1755271713/Cloud/CleanShot_2025-08-15_at_18.27.58_2x_fqlync.png)
5050

5151
Then, you can connect to your database using a PostgreSQL client. For example, using the `psql` command-line tool:
5252

@@ -67,7 +67,7 @@ To import or export a database dump for an environment:
6767
1. From the [organization's dashboard](../organizations/page.mdx), click on the environment's project.
6868
2. In the project's dashboard, click on the name of the environment. For example, "Production".
6969
3. In the environment's dashboard, click on the "Settings" tab.
70-
4. Choose the "Database" tab from the sidebar and find the "Database dump" section.
70+
4. Choose the "Storage" tab from the sidebar and find the "Database dump" section.
7171

7272
![Database dump section highlighted in the environment settings](https://res.cloudinary.com/dza7lstvk/image/upload/v1750169625/Cloud/CleanShot_2025-06-17_at_17.13.21_2x_l7vw3w.png)
7373

www/apps/cloud/app/environments/long-lived/page.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,9 +178,9 @@ This will change the view to the selected environment, and you'll see its detail
178178

179179
---
180180

181-
## View Environment Build Logs
181+
## View Environment Logs
182182

183-
You can view runtime logs for an environment in the "Logs" section of the environment's dashboard. These logs help you debug issues in your application.
183+
You can view build and runtime logs for an environment in the "Logs" section of the environment's dashboard. These logs help you debug issues in your Medusa application and storefront.
184184

185185
Learn more in the [Logs guide](../../logs/page.mdx).
186186

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

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Logs are essential for monitoring your application's health and debugging issues
2222
There are two types of logs for your environment's deployments:
2323

2424
- **Build logs**: Messages generated during the build process before deploying and starting the application. These logs are useful for debugging when a deployment's build fails.
25-
- **Runtime logs**: Messages logged by the Medusa application when it starts and while it's running, such as informational startup messages, HTTP requests, errors, and more. These logs are useful for debugging the application's deployment and runtime errors.
25+
- **Runtime logs**: Messages logged by the Medusa backend and storefront when they start and while they're running, such as informational startup messages, HTTP requests, errors, and more. These logs are useful for debugging the application's deployment and runtime errors.
2626

2727
---
2828

@@ -92,12 +92,12 @@ To download build logs, click the <InlineIcon Icon={ArrowDownTray} alt="download
9292

9393
## View Runtime Logs on Cloud
9494

95-
Runtime logs are useful for debugging the live deployment of an environment's Medusa application, especially when the deployment's status is "Deploy failed". They include logs for:
95+
Runtime logs are useful for debugging the live deployment of an environment's backend and storefront, especially when the deployment's status is "Deploy failed". They include logs for:
9696

97-
- Errors that occur during application startup.
98-
- Errors that occur when handling incoming HTTP requests, such as 404 errors or 500 server errors.
97+
- Errors that occur during backend or storefront startup.
98+
- Errors that occur when handling incoming HTTP requests in the backend, such as 404 errors or 500 server errors.
9999
- Scheduled jobs, subscribers, and background workflow executions not working as expected (if they log informational or error messages).
100-
- Other runtime issues that may occur while the application is running.
100+
- Other runtime issues that may occur while the backend or storefront are running.
101101

102102
You can only view the runtime logs of an environment's live deployment, as older deployments are no longer running and do not produce runtime logs.
103103

@@ -112,6 +112,15 @@ This will open the runtime logs page, where you can see the logs for the live de
112112

113113
![Runtime Logs for an environment](https://res.cloudinary.com/dza7lstvk/image/upload/v1750317226/Cloud/CleanShot_2025-06-19_at_10.13.36_2x_rfvows.png)
114114

115+
### Switch Between Backend and Storefront Runtime Logs
116+
117+
The runtime logs page shows logs for both the Medusa backend and, if you deployed a storefront alongside the Medusa application, the storefront. You can switch between the two using the toggle at the top of the logs table:
118+
119+
- **Backend**: Logs from the Medusa backend application, such as HTTP requests, errors, and startup messages.
120+
- **Storefront**: Logs from the storefront application. This option is only available if you deployed a storefront alongside the Medusa application.
121+
122+
![Runtime logs page with the backend and storefront toggle highlighted](https://res.cloudinary.com/dza7lstvk/image/upload/v1773825145/Cloud/CleanShot_2026-03-18_at_11.12.05_2x_pop7tp.png)
123+
115124
### Search Runtime Logs
116125

117126
You can search the runtime logs using the search bar at the top of the Logs page. This is useful for finding specific messages or errors in the logs.
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
import { EllipsisHorizontal } from "@medusajs/icons"
2+
import { InlineIcon } from "docs-ui"
3+
4+
export const metadata = {
5+
title: `Rename Project's Repository or Branch`,
6+
}
7+
8+
# {metadata.title}
9+
10+
In this guide, you'll learn how to handle renaming your Cloud project's Git repository or its main branch, and how it affects your Cloud project.
11+
12+
## Renaming Repository of a Cloud Project
13+
14+
If you rename the Git repository of your Cloud project, Medusa will automatically update the repository URL in your Cloud project settings to reflect the new repository name.
15+
16+
However, you need to ensure that your GitHub connection is configured to give Medusa access to the renamed repository. This is necessary for Medusa to continue fetching your code and deploying your environments on Cloud.
17+
18+
To reconfigure your GitHub connection after renaming your repository:
19+
20+
1. On GitHub, click on your avatar at the top right and choose "Settings" from the dropdown.
21+
2. In the left sidebar, click on "Applications".
22+
3. Click on the "Configure" button of the "Medusa" application.
23+
4. In the "Repository access" section, ensure that either "All repositories" is selected, or if "Only select repositories" is selected, ensure that the renamed repository is included in the list.
24+
25+
If your repository is an organization repository, ensure that the GitHub organization also has the renamed repository in its list of repositories that Medusa can access.
26+
27+
---
28+
29+
## Renaming Branch of a Cloud Project's Repository
30+
31+
If you rename the branch associated with an environment of your Cloud project, you need to update the deployment rules of that environment to use the new branch name.
32+
33+
To rename the branch associated with an environment of your Cloud project:
34+
35+
1. From the [organization's dashboard](../../organizations/page.mdx), click on the environment's project.
36+
2. In the project's dashboard, click on the name of the environment. For example, "Production".
37+
3. In the environment's dashboard, click on the "Settings" tab.
38+
4. Choose the "Deployment rules" tab from the sidebar.
39+
5. You'll find a `branch` rule. You can edit it by clicking the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon and choosing "Edit" from the dropdown.
40+
6. In the side window that opens, you can change the branch that the environment is connected to. For example, you can change it from `main` to `staging` to create a new deployment every time you push a commit to the `staging` branch.
41+
7. Click "Save" to apply the changes.
42+
43+
The deployment rules will take effect for next deployments. So, the next time you push a commit to the renamed branch, it will trigger a new deployment of the environment.

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

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,24 @@ If you're using a Medusa version before v2.7.0, contact support for assistance i
3030

3131
### Access S3 Configurations on Cloud
3232

33-
Since Cloud is a managed service, you can't directly access your S3 bucket or its configurations. Medusa also doesn't expose the S3 bucket connection or configuration details.
33+
Since Cloud is a managed service, you can't directly access your S3 bucket.
34+
35+
You can, however, access the S3 bucket details of your environment. This is useful when setting remote patterns in your storefront to allow loading assets from the S3 bucket.
36+
37+
To access the S3 bucket details of an environment:
38+
39+
1. From the [organization's dashboard](../organizations/page.mdx), click on the environment's project.
40+
2. In the project's dashboard, click on the name of the environment. For example, "Production".
41+
3. In the environment's dashboard, click on the "Settings" tab.
42+
4. Choose the "Storage" tab from the sidebar.
43+
5. In the "Object storage" section, you can find your full S3 file URL and your S3 endpoint.
44+
45+
From the S3 file URL, you can extract the bucket name and region. For example, if your S3 file URL is `https://s3.eu-central-1.amazonaws.com/medusajs.cloud-data-prod-euc1-123`:
46+
47+
- The bucket name is `medusajs.cloud-data-prod-euc1-123`.
48+
- The region is `eu-central-1`.
49+
50+
![S3 bucket details in Storage settings](https://res.cloudinary.com/dza7lstvk/image/upload/v1773824777/Cloud/CleanShot_2026-03-18_at_11.06.01_2x_imxylo.png)
3451

3552
### Override S3 Configurations on Cloud
3653

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ export const generatedEditDates = {
66
"app/deployments/page.mdx": "2026-01-07T13:12:29.617Z",
77
"app/organizations/page.mdx": "2025-12-17T11:56:48.669Z",
88
"app/notifications/page.mdx": "2025-10-15T15:25:33.672Z",
9-
"app/database/page.mdx": "2025-10-20T15:47:46.364Z",
9+
"app/database/page.mdx": "2026-03-18T09:04:03.570Z",
1010
"app/redis/page.mdx": "2025-10-15T15:22:34.997Z",
11-
"app/s3/page.mdx": "2025-10-15T15:23:02.835Z",
11+
"app/s3/page.mdx": "2026-03-18T09:06:39.127Z",
1212
"app/loyalty-plugin/page.mdx": "2025-10-15T15:27:40.303Z",
13-
"app/logs/page.mdx": "2026-01-08T09:08:23.867Z",
13+
"app/logs/page.mdx": "2026-03-18T09:15:07.187Z",
1414
"app/update-medusa/page.mdx": "2026-01-08T08:54:50.149Z",
1515
"app/connect-storefront/page.mdx": "2026-01-08T08:50:31.830Z",
1616
"app/environments/environment-variables/page.mdx": "2026-01-07T12:56:08.417Z",
17-
"app/environments/long-lived/page.mdx": "2026-01-07T13:10:54.148Z",
17+
"app/environments/long-lived/page.mdx": "2026-03-18T09:15:59.684Z",
1818
"app/environments/preview/page.mdx": "2026-02-05T15:06:26.801Z",
1919
"app/faq/page.mdx": "2026-01-08T08:43:23.224Z",
2020
"app/billing/page.mdx": "2025-12-17T12:39:37.397Z",
@@ -31,5 +31,6 @@ export const generatedEditDates = {
3131
"app/user/page.mdx": "2025-12-17T12:03:18.968Z",
3232
"app/deployments/access/page.mdx": "2026-01-08T08:52:48.924Z",
3333
"app/projects/prerequisites/page.mdx": "2026-02-09T14:40:20.415Z",
34-
"app/storefront/page.mdx": "2026-02-09T14:40:39.790Z"
34+
"app/storefront/page.mdx": "2026-02-09T14:40:39.790Z",
35+
"app/projects/rename-repo-branch/page.mdx": "2026-03-18T09:23:58.584Z"
3536
}

www/apps/cloud/generated/sidebar.mjs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,14 @@ export const generatedSidebars = [
7373
"title": "Prerequisites",
7474
"path": "/projects/prerequisites",
7575
"children": []
76+
},
77+
{
78+
"loaded": true,
79+
"isPathHref": true,
80+
"type": "link",
81+
"title": "Rename Repository",
82+
"path": "/projects/rename-repo-branch",
83+
"children": []
7684
}
7785
]
7886
},

www/apps/cloud/sidebar.mjs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ export const sidebar = [
5151
title: "Prerequisites",
5252
path: "/projects/prerequisites",
5353
},
54+
{
55+
type: "link",
56+
title: "Rename Repository",
57+
path: "/projects/rename-repo-branch",
58+
},
5459
],
5560
},
5661
{

0 commit comments

Comments
 (0)