Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(troubleshooting): Add troubleshooting section to docs #2860

Merged
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions packages/create/templates/readme.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,15 @@ can set `dbConnectionOptions.synchronize` to `true`. This will cause the databas
on each start, removing the need for migration files. Note that this is **not** recommended once you have production
data that you cannot lose.

## Troubleshooting

### Error: Could not load the "sharp" module using the \[OS\]-x\[Architecture\] runtime when running Vendure server.

- Make sure your Node version is ^18.17.0 || ^20.3.0 || >=21.0.0 to support the Sharp library.
- Make sure your package manager is up to date.
- **Not recommended**: if none of the above helps to resolve the issue, install sharp specifying your machines OS and Architecture. For example: `pnpm install sharp --config.platform=linux --config.architecture=x64` or `npm install sharp --os linux --cpu x64`

---

You can also run any pending migrations manually, without starting the server via the "vendure migrate" command.
callumhemming marked this conversation as resolved.
Show resolved Hide resolved

Loading