docs: add worker mode documentation + improvements (#11812)

This commit is contained in:
Shahed Nasser
2025-03-11 19:12:32 +02:00
committed by GitHub
parent ef66ff8f99
commit 267af9f3f6
10 changed files with 8414 additions and 8168 deletions
@@ -47,11 +47,9 @@ When you deploy your Medusa application, make sure your chosen hosting provider
### Worker Mode
The `workerMode` configuration determines which mode the Medusa application runs in.
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.
When you deploy the Medusa application, you deploy two instances: one in server mode, and one in worker mode.
Learn more about the `workerMode` configuration in [this document](../../configurations/medusa-config/page.mdx#workermode).
Learn more about worker mode in the [Worker Module chapter](../../production/worker-mode/page.mdx).
So, add the following configuration in `medusa-config.ts`:
@@ -31,6 +31,19 @@ Your server connects to a PostgreSQL database, Redis, and other services relevan
When you deploy your Medusa application, you also deploy the Medusa Admin. For optimal experience, your hosting provider and plan must offer at least 2GB of RAM.
### Deploy Server and Worker Instances
By default, Medusa runs all processes in a single instance. This includes the server that handles incoming requests and the worker that processes background tasks. While this works for development, its not optimal for production environments as many background tasks can be long-running or resource-heavy.
Instead, you should deploy two instances:
- A server instance, which handles incoming requests to the applications API routes.
- A worker instance, which processes background tasks, including scheduled jobs and subscribers.
You dont need to set up different projects for each instance. Instead, you can configure the Medusa application to run in different modes based on environment variables.
Learn more about worker modes and how to configure them in the [Worker Mode chapter](../production/worker-mode/page.mdx).
### How to Deploy Medusa?
Medusa Cloud is our managed services offering that makes deploying and operating Medusa applications possible without having to worry about configuring, scaling, and maintaining infrastructure. Medusa Cloud hosts your server, Admin dashboard, database, and Redis instance.