asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: remove start-cluster command + update start options (#12116)

Browse Source
This commit is contained in:
Shahed Nasser
2025-04-08 15:47:10 +03:00
committed by GitHub
parent 9ac74eead4
commit 78ee2e3063
7 changed files with 12616 additions and 12729 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/medusa-cli/commands/start-cluster/page.mdx
-85
View File
@@ -1,85 +0,0 @@
---
sidebar_label: "start-cluster"
sidebar_position: 8
---
import { Table } from "docs-ui"
export const metadata = {
title: `start-cluster Command - Medusa CLI Reference`,
}
# {metadata.title}
Starts the Medusa application in [cluster mode](https://expressjs.com/en/advanced/best-practice-performance.html#run-your-app-in-a-cluster).
Running in cluster mode significantly improves performance as the workload and tasks are distributed among all available instances instead of a single one.
```bash
npx medusa start-cluster
```
#### Options
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>Option</Table.HeaderCell>
<Table.HeaderCell>Description</Table.HeaderCell>
<Table.HeaderCell>Default</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`-c <number>`, `--cpus <number>`
</Table.Cell>
<Table.Cell>
The number of CPUs that Medusa can consume.
</Table.Cell>
<Table.Cell>
Medusa will try to consume all CPUs.
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`-H <host>`, `--host <host>`
</Table.Cell>
<Table.Cell>
Set host of the Medusa server.
</Table.Cell>
<Table.Cell>
`localhost`
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`-p <port>`, `--port <port>`
</Table.Cell>
<Table.Cell>
Set port of the Medusa server.
</Table.Cell>
<Table.Cell>
`9000`
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
www/apps/resources/app/medusa-cli/commands/start/page.mdx
+17
View File
@@ -60,6 +60,23 @@ npx medusa start
`9000`
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`--cluster <number>`
</Table.Cell>
<Table.Cell>
Start Medusa's Node.js server in [cluster mode](https://expressjs.com/en/advanced/best-practice-performance.html#run-your-app-in-a-cluster). Running in cluster mode significantly improves performance as the workload and tasks are distributed among all available instances instead of a single one.
</Table.Cell>
<Table.Cell>
Cluster mode is disabled by default. If the option is passed but no number is passed, Medusa will try to consume all available CPU cores.
</Table.Cell>
</Table.Row>
</Table.Body>