Custom Server

Examples

• Basic custom server
• Express integration
• Hapi integration
• Koa integration
• SSR Caching

Typically you start your next server with next start. It's possible, however, to start a server 100% programmatically in order to use custom route patterns.

A custom server can not be deployed on Vercel, the platform Next.js was made for.

Before deciding to use a custom server please keep in mind that it should only be used when the integrated router of Next.js can't meet your app requirements. A custom server will remove important performance optimizations, like serverless functions and Automatic Static Optimization.

Take a look at the following example of a custom server:

// server.js
const { createServer } = require('http')
const { parse } = require('url')
const next = require('next')

const dev = process.env.NODE_ENV !== 'production'
const app = next({ dev })
const handle = app.getRequestHandler()

app.prepare().then(() => {
  createServer((req, res) => {
    // Be sure to pass `true` as the second argument to `url.parse`.
    // This tells it to parse the query portion of the URL.
    const parsedUrl = parse(req.url, true)
    const { pathname, query } = parsedUrl

    if (pathname === '/a') {
      app.render(req, res, '/a', query)
    } else if (pathname === '/b') {
      app.render(req, res, '/b', query)
    } else {
      handle(req, res, parsedUrl)
    }
  }).listen(3000, (err) => {
    if (err) throw err
    console.log('> Ready on http://localhost:3000')
  })
})

server.js doesn't go through babel or webpack. Make sure the syntax and sources this file requires are compatible with the current node version you are running.

Then, to run the custom server you'll need to update the scripts in package.json, like so:

"scripts": {
  "dev": "node server.js",
  "build": "next build",
  "start": "NODE_ENV=production node server.js"
}

---

The custom server uses the following import to connect the server with the Next.js application:

const next = require('next')
const app = next({})

The above next import is a function that receives an object with the following options:

• dev: Boolean - Whether or not to launch Next.js in dev mode. Defaults to false
• dir: String - Location of the Next.js project. Defaults to '.'
• quiet: Boolean - Hide error messages containing server information. Defaults to false
• conf: object - The same object you would use in next.config.js. Defaults to {}

The returned app can then be used to let Next.js handle requests as required.

Disabling file-system routing

By default, Next will serve each file in the pages folder under a pathname matching the filename. If your project uses a custom server, this behavior may result in the same content being served from multiple paths, which can present problems with SEO and UX.

To disable this behavior and prevent routing based on files in pages, open next.config.js and disable the useFileSystemPublicRoutes config:

module.exports = {
  useFileSystemPublicRoutes: false,
}

Note that useFileSystemPublicRoutes disables filename routes from SSR; client-side routing may still access those paths. When using this option, you should guard against navigation to routes you do not want programmatically.

You may also wish to configure the client-side router to disallow client-side redirects to filename routes; for that refer to router.beforePopState.