Skip to content

add warnings in the aws and cloudflare docs regarding the limited windows support #49

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 2 commits into from
Jan 13, 2025
Merged

add warnings in the aws and cloudflare docs regarding the limited windows support #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de4f3b8
add warnings in the aws and cloudflare docs regarding the limited win…
dario-piotrowicz Jan 13, 2025
ba0dcd3
create a shared `WindowsSupport.mdx` and mention CI/CD solution
dario-piotrowicz Jan 13, 2025
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
7 changes: 7 additions & 0 deletions pages/aws/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { SITE } from '../../config';
import { Callout } from 'nextra/components';
import WindowsSupport from '../../shared/WindowsSupport.mdx';

<Callout>
This docs is for the V3 of OpenNext. If you are looking for the V2 docs, you can find them [here](/aws/v2).
Expand Down Expand Up @@ -44,4 +45,10 @@ OpenNext aims to support all Next.js 14 features. Some features are work in prog

---

<Callout type='info'>
<WindowsSupport />
</Callout>

---

[Get started](/aws/get_started) with deploying your app with OpenNext and your favorite framework.
5 changes: 5 additions & 0 deletions pages/cloudflare/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { SITE } from '../../config';
import { Callout } from 'nextra/components';
import WindowsSupport from '../../shared/WindowsSupport.mdx';

## Cloudflare

Expand Down Expand Up @@ -57,6 +58,10 @@ We will update the list as we progress towards releasing 1.0.

We welcome both contributions and feedback!

### Windows support

<WindowsSupport />

### How @opennextjs/cloudflare Works

The OpenNext Cloudflare adapter works by taking the Next.js build output and transforming it, so that it can run in Cloudflare Workers.
Expand Down
12 changes: 12 additions & 0 deletions shared/WindowsSupport.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
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)
- 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/),
- 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
Loading