Skip to content

Update middleware documentation for custom server #33535

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 4 commits into from
Jan 21, 2022
Merged

Update middleware documentation for custom server #33535

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d4f081a
Update middleware documentation for custom server
saevarb Jan 21, 2022
16fc45e
Apply suggestions from code review
ijjk Jan 21, 2022
0de75bb
lint-fix
ijjk Jan 21, 2022
8a81f54
Merge branch 'canary' into patch-1
ijjk Jan 21, 2022
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
13 changes: 13 additions & 0 deletions docs/middleware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,19 @@ Middleware runs directly after `redirects` and `headers`, before the first files

Middleware uses a [strict runtime](/docs/api-reference/edge-runtime.md) that supports standard Web APIs like `fetch`. This works out of the box using `next start`, as well as on Edge platforms like Vercel, which use [Edge Functions](http://www.vercel.com/edge).

## Custom Server

When using a custom server with middleware, you must specify the hostname and port when instantiating your `NextApp`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this should be moved to the Custom Server docs, since it only applies to a very small segment of Next.js users who are ejecting for a custom server.


```ts
import next from "next";
// ...
const port = process.env.PORT ? +process.env.PORT : 3000;
const dev = process.env.NODE_ENV !== "production";
const app = next({ dev, customServer: true, hostname: "localhost", port });
```


## Related

<div class="card">
Expand Down