import { Prerequisites } from "docs-ui"

export const metadata = { title: General Medusa Application Deployment Guide, }

{metadata.title}

In this guide, you'll learn the general steps to deploy your Medusa application. How you apply these steps depend on your chosen hosting provider or platform.

Before deciding to self-host your Medusa application, consider reading the Cloud vs. Self-Hosting comparison guide. By using Cloud, you can avoid the complexities and challenges of self-hosting, while benefiting from automated deployment, scaling, and maintenance.

With Cloud, you also maintain full customization control as you deploy your own modules and customizations directly from GitHub:

• Push to deploy.
• Multiple testing environments.
• Preview environments for new PRs.
• Test on production-like data.
• Storefront deployment.
• Emails setup.
• And more.

<Prerequisites items={[ { text: "Medusa application’s codebase hosted on GitHub repository.", link: "/learn" }, ]} />

What You'll Deploy

When you deploy the Medusa application, you need to deploy the following resources:

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

1. Configure Medusa Application

Worker Mode

The workerMode configuration determines which mode the Medusa application runs in. When you deploy the Medusa application, you deploy two instances: one in server mode, and one in worker mode.

Learn more about worker mode in the Worker Module chapter.

So, add the following configuration in medusa-config.ts:

module.exports = defineConfig({
  projectConfig: {
    // ...
    workerMode: process.env.MEDUSA_WORKER_MODE as "shared" | "worker" | "server",
  },
})

Later, you’ll set different values of the MEDUSA_WORKER_MODE environment variable for each Medusa application deployment or instance.

Configure Medusa Admin

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:

module.exports = defineConfig({
  // ...
  admin: {
    disable: process.env.DISABLE_MEDUSA_ADMIN === "true",
  },
})

Later, you’ll set different values of the DISABLE_MEDUSA_ADMIN environment variable for each Medusa application instance.

Configure Redis URL

The redisUrl configuration specifies the connection URL to Redis to store the Medusa server's session.

Learn more in the Medusa Configuration documentation.

So, add the following configuration in medusa-config.ts :

module.exports = defineConfig({
  projectConfig: {
    // ...
    redisUrl: process.env.REDIS_URL,
  },
})

2. Add predeploy Script

Before you start the Medusa application in production, you should always run migrations and sync links.

So, add the following script in package.json:

"scripts": {
  // ...
  "predeploy": "medusa db:migrate"
},

3. Install Production Modules and Providers

By default, your Medusa application uses modules and providers useful for development, such as the Local File Module Provider.

It’s highly recommended to instead use modules and providers suitable for production, including:

• Redis Caching Module
• Redis Event Bus Module
• Workflow Engine Redis Module
• Redis Locking Module Provider
• PostHog Analytics Module Provider (If you're using analytics in your application. You can also use other analytics module providers that are production-ready).
• S3 File Module Provider (or other file module providers that are production-ready).
• SendGrid Notification Module Provider (or other notification module providers that are production-ready).

The Caching Module was introduced in Medusa v2.11.0 to replace the deprecated Cache Module.

Then, add these modules in medusa-config.ts:

import { Modules } from "@medusajs/framework/utils"

module.exports = defineConfig({
  // ...
  modules: [
    {
      resolve: "@medusajs/medusa/caching",
      options: {
        providers: [
          {
            resolve: "@medusajs/caching-redis",
            id: "caching-redis",
            is_default: true,
            options: {
              redisUrl: process.env.CACHE_REDIS_URL,
            },
          },
        ],
      },
    },
    {
      resolve: "@medusajs/medusa/event-bus-redis",
      options: {
        redisUrl: process.env.REDIS_URL,
      },
    },
    {
      resolve: "@medusajs/medusa/workflow-engine-redis",
      options: {
        redis: {
          // Note: This was `url` before v2.12.2
          // It's now deprecated in favor of `redisUrl`
          redisUrl: process.env.REDIS_URL,
        },
      },
    },
    {
      resolve: "@medusajs/medusa/locking",
      options: {
        providers: [
          {
            resolve: "@medusajs/medusa/locking-redis",
            id: "locking-redis",
            is_default: true,
            options: {
              redisUrl: process.env.LOCKING_REDIS_URL,
            },
          },
        ],
      },
    },

  ],
})

Check out the Integrations and Infrastructure Modules documentation for other modules and providers to use.

4. Create PostgreSQL and Redis Databases

Your Medusa application must connect to PostgreSQL and Redis databases. So, before you deploy it, create production PostgreSQL and Redis databases.

If your hosting provider doesn't support databases, you can use Neon for PostgreSQL database hosting, and Redis Cloud for the Redis database hosting.

After hosting both databases, keep their connection URLs for the next steps.

5. Deploy Medusa Application in Server Mode

As mentioned earlier, you'll deploy two instances or create two deployments of your Medusa application: one in server mode, and the other in worker mode.

The deployment steps depend on your hosting provider. This section provides the general steps to perform during the deployment.

Set Environment Variables

When setting the environment variables of the Medusa application, set the following variables:

COOKIE_SECRET=supersecret # TODO GENERATE SECURE SECRET
JWT_SECRET=supersecret  # TODO GENERATE SECURE SECRET
STORE_CORS= # STOREFRONT URL
ADMIN_CORS= # ADMIN URL
AUTH_CORS= # STOREFRONT AND ADMIN URLS, SEPARATED BY COMMAS
DISABLE_MEDUSA_ADMIN=false
MEDUSA_WORKER_MODE=server
PORT=9000
DATABASE_URL= # POSTGRES DATABASE URL
REDIS_URL= # REDIS DATABASE URL

Where:

• The value of COOKIE_SECRET and JWT_SECRET must be a randomly generated secret.
• STORE_CORS's value is the URL of your storefront. If you don’t have it yet, you can skip adding it for now.
• ADMIN_CORS's value is the URL of the admin dashboard, which is the same as the server Medusa application. You can add it later if you don't currently have it.
• AUTH_CORS's value is the URLs of any application authenticating users, customers, or other actor types, such as the storefront and admin URLs. The URLs are separated by commas. If you don’t have the URLs yet, you can set its value later.
• Set DISABLE_MEDUSA_ADMIN's value to false so that the admin is built with the server application.
• 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 Infrastructure 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

The Medusa application's production build, which is created using the build command, outputs the Medusa application to .medusa/server. So, you must install the dependencies in the .medusa/server directory, then run the start command in it.

If your hosting provider doesn't support setting a current-working directory, set the start command to the following:

cd .medusa/server && npm install && npm run predeploy && npm run start

Notice that you run the predeploy command before starting the Medusa application to run migrations and sync links whenever there's an update.

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 you’ve obtained the Medusa application’s URL, add the following configuration to medusa-config.ts:

module.exports = defineConfig({
  // ...
  admin: {
    // ...
    backendUrl: process.env.MEDUSA_BACKEND_URL,
  },
})

Then, push the changes to the GitHub repository or deployed application.

In your hosting provider, add or modify the following environment variables for the Medusa application in server mode:

ADMIN_CORS= # MEDUSA APPLICATION URL
AUTH_CORS= # ADD MEDUSA APPLICATION URL
MEDUSA_BACKEND_URL= # URL TO DEPLOYED MEDUSA APPLICATION

Where you set the value of ADMIN_CORS and MEDUSA_BACKEND_URL to the Medusa application’s 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.

Remember to separate URLs in AUTH_CORS by commas.

6. Deploy Medusa Application in Worker Mode

Next, you'll deploy the Medusa application in worker mode.

As explained in the previous section, the deployment steps depend on your hosting provider. This section provides the general steps to perform during the deployment.

Set Environment Variables

When setting the environment variables of the Medusa application, set the following variables:

COOKIE_SECRET=supersecret # TODO GENERATE SECURE SECRET
JWT_SECRET=supersecret  # TODO GENERATE SECURE SECRET
DISABLE_MEDUSA_ADMIN=true
MEDUSA_WORKER_MODE=worker
PORT=9000
DATABASE_URL= # POSTGRES DATABASE URL
REDIS_URL= # REDIS DATABASE URL

Where:

• The value of COOKIE_SECRET and JWT_SECRET must be a randomly generated secret.
• Set DISABLE_MEDUSA_ADMIN's value to true so that the admin isn't built with the worker application.
• 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 Infrastructure Modules.

Set Start Command

The Medusa application's production build, which is created using the build command, outputs the Medusa application to .medusa/server. So, you must install the dependencies in the .medusa/server directory, then run the start command in it.

If your hosting provider doesn't support setting a current-working directory, set the start command to the following:

cd .medusa/server && npm install && npm run start

7. Test Deployed Application

Once the application is deployed and live, go to <APP_URL>/health, where <APP_URL> is the URL of the Medusa application in server mode. If the deployment was successful, you’ll see the OK response.

The Medusa Admin is also available at <APP_URL>/app.

Create Admin User

If your hosting provider supports running commands in your Medusa application's directory, run the following command to create an admin user:

npx medusa user -e [email protected] -p supersecret

Replace the email [email protected] and password supersecret with the credentials you want.

You can use these credentials to log into the Medusa Admin dashboard.