docs: small improvements to the general deployment guide (#11978)

This commit is contained in:
Shahed Nasser
2025-03-25 19:25:53 +02:00
committed by GitHub
parent 178e034561
commit cbd1786ca5
4 changed files with 2194 additions and 1412 deletions

View File

@@ -32,14 +32,17 @@ With Medusa Cloud, you maintain full customization control as you deploy your ow
},
]} />
## Hosting Provider Requirements
## What You'll Deploy
When you deploy your Medusa application, make sure your chosen hosting provider supports deploying the following resources:
When you deploy the Medusa application, you need to deploy the following resources:
1. PostgreSQL database: If your hosting provider doesn't support database hosting, you must find another hosting provider for the PostgreSQL database.
2. Redis database: If your hosting provider doesn't support database hosting, you must find another hosting provider for the Redis database.
3. Medusa application in server and worker mode. This means your hosting provider should support deploying two applications or instances from the same codebase.
4. For optimal experience, the hosting provider and plan must offer at least 2GB of RAM.
1. PostgreSQL database: This is the database that will hold your Medusa application's details.
2. Redis database: This is the database that will store the Medusa server's session.
3. Medusa application in [server and worker mode](../../production/worker-mode/page.mdx), where:
- The server mode handles incoming API requests and serving the Medusa Admin dashboard.
- The worker mode handles background tasks, such as scheduled jobs and subscribers.
So, when choosing a hosting provider, make sure it supports deploying these resources. Also, for optimal experience, the hosting provider and plan must offer at least 2GB of RAM.
---
@@ -66,7 +69,9 @@ Later, youll set different values of the `MEDUSA_WORKER_MODE` environment var
### Configure Medusa Admin
You need to disable the Medusa Admin in the worker Medusa application, while keeping it enabled in the server Medusa application. So, add the following configuration in `medusa-config.ts`:
The Medusa Admin is served by the Medusa server application. So, you need to disable it in the worker Medusa application only.
To disable the Medusa Admin in the worker Medusa application while keeping it enabled in the server Medusa application, add the following configuration in `medusa-config.ts`:
```ts title="medusa-config.ts"
module.exports = defineConfig({
@@ -77,7 +82,7 @@ module.exports = defineConfig({
})
```
Later, youll set different values of the `DISABLE_MEDUSA_ADMIN` environment variable.
Later, youll set different values of the `DISABLE_MEDUSA_ADMIN` environment variable for each Medusa application instance.
### Configure Redis URL
@@ -212,7 +217,7 @@ Where:
- Set the PostgreSQL database's connection URL as the value of `DATABASE_URL`
- Set the Redis database's connection URL as the value of `REDIS_URL`.
Feel free to add any other relevant environment variables, such as for integrations and architectural modules.
Feel free to add any other relevant environment variables, such as for integrations and architectural modules. If you're using environment variables in your admin customizations, make sure to set them as well, as they're inlined during the build process.
### Set Start Command
@@ -228,6 +233,8 @@ Notice that you run the `predeploy` command before starting the Medusa applicati
### Set Backend URL in Admin Configuration
The Medusa Admin is built and hosted statically. To send requests to the Medusa server application, you must set the backend URL in the Medusa Admin's configuration.
After youve obtained the Medusa applications URL, add the following configuration to `medusa-config.ts`:
```ts title="medusa-config.ts"
@@ -252,6 +259,8 @@ MEDUSA_BACKEND_URL= # URL TO DEPLOYED MEDUSA APPLICATION
Where you set the value of `ADMIN_CORS` and `MEDUSA_BACKEND_URL` to the Medusa applications URL, and you add the URL to `AUTH_CORS`.
After setting the environment variables, make sure to restart the deployment for the changes to take effect.
<Note title="Tip">
Remember to separate URLs in `AUTH_CORS` by commas.

View File

@@ -74,3 +74,10 @@ To check the current environment, Vite exposes two variables:
Learn more about other Vite environment variables in the [Vite documentation](https://vite.dev/guide/env-and-mode).
---
## Environment Variables in Production
When you build the Medusa application, including the Medusa Admin, with the `build` command, the environment variables are inlined into the build. This means that you can't change the environment variables without rebuilding the application.
For example, the `VITE_MY_API_KEY` environment variable in the example above will be replaced with the actual value during the build process.

View File

@@ -97,7 +97,7 @@ export const generatedEditDates = {
"app/learn/fundamentals/custom-cli-scripts/seed-data/page.mdx": "2024-12-09T14:38:06.385Z",
"app/learn/fundamentals/environment-variables/page.mdx": "2025-03-11T08:55:03.343Z",
"app/learn/build/page.mdx": "2024-12-09T11:05:17.383Z",
"app/learn/deployment/general/page.mdx": "2025-03-11T15:30:23.949Z",
"app/learn/deployment/general/page.mdx": "2025-03-25T13:32:56.287Z",
"app/learn/fundamentals/workflows/multiple-step-usage/page.mdx": "2024-11-25T16:19:32.169Z",
"app/learn/installation/page.mdx": "2025-03-11T08:55:12.967Z",
"app/learn/fundamentals/data-models/check-constraints/page.mdx": "2024-12-06T14:34:50.384Z",
@@ -108,7 +108,7 @@ export const generatedEditDates = {
"app/learn/customization/reuse-customizations/page.mdx": "2025-01-22T10:01:57.665Z",
"app/learn/update/page.mdx": "2025-01-27T08:45:19.030Z",
"app/learn/fundamentals/module-links/query-context/page.mdx": "2025-02-12T16:59:20.963Z",
"app/learn/fundamentals/admin/environment-variables/page.mdx": "2025-03-24T06:52:16.903Z",
"app/learn/fundamentals/admin/environment-variables/page.mdx": "2025-03-25T13:32:19.713Z",
"app/learn/fundamentals/api-routes/parse-body/page.mdx": "2025-02-14T08:32:25.596Z",
"app/learn/fundamentals/admin/routing/page.mdx": "2025-02-24T09:50:37.495Z",
"app/learn/resources/contribution-guidelines/admin-translations/page.mdx": "2025-02-11T16:57:46.726Z",

File diff suppressed because it is too large Load Diff