Skip to content

Commit 538d221

Browse files
authored
doc: add details to windows support (#141)
1 parent bdd4d28 commit 538d221

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

shared/WindowsSupport.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
OpenNext can be used on Windows systems but Windows full support is not guaranteed because:
22

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

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

11-
- running OpenNext using [WSL2](https://learn.microsoft.com/en-us/windows/wsl/),
10+
- running OpenNext using [the Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/),
1211
- in a Linux Virtual Machine or
1312
- develop your application using the standard Next.js tooling and deploy it using OpenNext in CI/CD systems such
1413
as [GitHub Actions](https://github.com/features/actions) that run linux/MacOS environments
14+
15+
Windows Subsystem for Linux (WSL) allows you to run a Linux environment on your Windows machine, without the need for
16+
a separate virtual machine or dual booting. Visual Studio Code has [an extension](https://code.visualstudio.com/docs/remote/wsl)
17+
that makes developing with WSL very easy.

0 commit comments

Comments
 (0)