Skip to content

doc: add details to windows support #141

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 2, 2025
Merged

doc: add details to windows support #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 3 deletions shared/WindowsSupport.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
OpenNext can be used on Windows systems but Windows full support is not guaranteed because:

- historically the Next.js tooling itself has had Windows support issues
(and OpenNext is built on these tools)
- Next.js tooling itself has Windows support issues and OpenNext is built on these tools
- the OpenNext team has limited capacity and fully supporting Windows (given the point above)
has been determined to be a lower priority, thus the effort and testing on Windows is limited

Given the above, you can develop your application under Windows at your own risk. If you don't have an alternative we
recommend either:

- running OpenNext using [WSL2](https://learn.microsoft.com/en-us/windows/wsl/),
- running OpenNext using [the Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/),
- in a Linux Virtual Machine or
- develop your application using the standard Next.js tooling and deploy it using OpenNext in CI/CD systems such
as [GitHub Actions](https://github.com/features/actions) that run linux/MacOS environments

Windows Subsystem for Linux (WSL) allows you to run a Linux environment on your Windows machine, without the need for
a separate virtual machine or dual booting. Visual Studio Code has [an extension](https://code.visualstudio.com/docs/remote/wsl)
that makes developing with WSL very easy.