Update middleware documentation for custom server #33535
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Upgrading from 12.0.0 to 12.0.8 results in `[dev] error - Error: To use middleware you must provide a `hostname` and `port` to the Next.js Server` and this requirement did not seem to be documented anywhere.
saevarb
requested review from
huozhi,
ijjk,
leerob,
padmaia,
shuding,
styfle and
timneutkens
as code owners
styfle
reviewed
Jan 21, 2022
styfle
reviewed
Jan 21, 2022
There was a problem hiding this comment.
Adding @javivelasco as a reviewer since it looks like this error was introduced in #32368
javivelasco
previously approved these changes
Jan 21, 2022
Co-authored-by: Steven <steven@ceriously.com>
ijjk
previously approved these changes
Jan 21, 2022
ijjk
approved these changes
Jan 21, 2022
leerob
reviewed
Jan 22, 2022
| @@ -76,6 +76,18 @@ 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`. | |||
There was a problem hiding this comment.
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.
1 task
kodiakhq bot
pushed a commit
that referenced
this pull request
Jan 27, 2022
This moves the note about custom server handling for middleware to the custom server document. ## Documentation / Examples - [x] Make sure the linting passes by running `yarn lint` x-ref: #33535 (comment)
natew
pushed a commit
to natew/next.js
that referenced
this pull request
Feb 16, 2022
Upgrading from 12.0.0 to 12.0.8 results in `[dev] error - Error: To use middleware you must provide a `hostname` and `port` to the Next.js Server` and this requirement did not seem to be documented anywhere. Fixes vercel#33450 which seems to have been erroneously closed. ## Bug - [X] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `yarn lint` Co-authored-by: JJ Kasper <22380829+ijjk@users.noreply.github.com>
natew
pushed a commit
to natew/next.js
that referenced
this pull request
Feb 16, 2022
This moves the note about custom server handling for middleware to the custom server document. ## Documentation / Examples - [x] Make sure the linting passes by running `yarn lint` x-ref: vercel#33535 (comment)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Upgrading from 12.0.0 to 12.0.8 results in
[dev] error - Error: To use middleware you must provide ahostnameandportto the Next.js Serverand this requirement did not seem to be documented anywhere. Fixes #33450 which seems to have been erroneously closed.Bug
fixes #numbercontributing.mdFeature
fixes #numbercontributing.mdDocumentation / Examples
yarn lint