Deploying
Congratulations! You're here because you are ready to deploy your Next.js application. This page will show how to deploy either managed or self-hosted using the Next.js Build API.
Next.js Build API
next build
generates an optimized version of your application for production. This standard output includes:
- HTML files for pages using
getStaticProps
or Automatic Static Optimization - CSS files for global styles or for individually scoped styles
- JavaScript for pre-rendering dynamic content from the Next.js server
- JavaScript for interactivity on the client-side through React
This output is generated inside the .next
folder:
.next/static/chunks/pages
– Each JavaScript file inside this folder relates to the route with the same name. For example,.next/static/chunks/pages/about.js
would be the JavaScript file loaded when viewing the/about
route in your application.next/static/media
– Statically imported images fromnext/image
are hashed and copied here.next/static/css
– Global CSS files for all pages in your application.next/server/pages
– The HTML and JavaScript entry points prerendered from the server. The.nft.json
files are created when Output File Tracing is enabled and contain all the file paths that depend on a given page..next/server/chunks
– Shared JavaScript chunks used in multiple places throughout your application.next/cache
– Output for the build cache and cached images, responses, and pages from the Next.js server. Using a cache helps decrease build times and improve performance of loading images
All JavaScript code inside .next
has been compiled and browser bundles have been minified to help achieve the best performance and support all modern browsers.
Managed Next.js with Vercel
Vercel is the fastest way to deploy your Next.js application with zero configuration.
When deploying to Vercel, the platform automatically detects Next.js, runs next build
, and optimizes the build output for you, including:
- Persisting cached assets across deployments if unchanged
- Immutable deployments with a unique URL for every commit
- Pages are automatically statically optimized, if possible
- Assets (JavaScript, CSS, images, fonts) are compressed and served from a Global Edge Network
- API Routes are automatically optimized as isolated Serverless Functions that can scale infinitely
- Middleware is automatically optimized as Edge Functions that have zero cold starts and boot instantly
In addition, Vercel provides features like:
- Automatic performance monitoring with Next.js Speed Insights
- Automatic HTTPS and SSL certificates
- Automatic CI/CD (through GitHub, GitLab, Bitbucket, etc.)
- Support for Environment Variables
- Support for Custom Domains
- Support for Image Optimization with
next/image
- Instant global deployments via
git push
Deploy a Next.js application to Vercel for free to try it out.
Self-Hosting
You can self-host Next.js with support for all features using Node.js or Docker. You can also do a Static HTML Export, which has some limitations.
Node.js Server
Next.js can be deployed to any hosting provider that supports Node.js. For example, AWS EC2 or a DigitalOcean Droplet.
First, ensure your package.json
has the "build"
and "start"
scripts:
{
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start"
}
}
Then, run npm run build
to build your application. Finally, run npm run start
to start the Node.js server. This server supports all features of Next.js.
If you are using
next/image
, consider addingsharp
for more performant Image Optimization in your production environment by runningnpm install sharp
in your project directory. On Linux platforms,sharp
may require additional configuration to prevent excessive memory usage.
Docker Image
Next.js can be deployed to any hosting provider that supports Docker containers. You can use this approach when deploying to container orchestrators such as Kubernetes or HashiCorp Nomad, or when running inside a single node in any cloud provider.
- Install Docker on your machine
- Clone the with-docker example
- Build your container:
docker build -t nextjs-docker .
- Run your container:
docker run -p 3000:3000 nextjs-docker
If you need to use different Environment Variables across multiple environments, check out our with-docker-multi-env example.
Static HTML Export
If you’d like to do a static HTML export of your Next.js app, follow the directions on our Static HTML Export documentation.
Other Services
The following services support Next.js v12+
. Below, you’ll find examples or guides to deploy Next.js to each service.
Managed Server
Good to know: There are also managed platforms that allow you to use a Dockerfile as shown in the example above.
Static Only
The following services only support deploying Next.js using output: 'export'
.
You can also manually deploy the output from output: 'export'
to any static hosting provider, often through your CI/CD pipeline like GitHub Actions, Jenkins, AWS CodeBuild, Circle CI, Azure Pipelines, and more.
Serverless
Good to know: Not all serverless providers implement the Next.js Build API from
next start
. Please check with the provider to see what features are supported.
Automatic Updates
When you deploy your Next.js application, you want to see the latest version without needing to reload.
Next.js will automatically load the latest version of your application in the background when routing. For client-side navigations, next/link
will temporarily function as a normal <a>
tag.
Good to know: If a new page (with an old version) has already been prefetched by
next/link
, Next.js will use the old version. Navigating to a page that has not been prefetched (and is not cached at the CDN level) will load the latest version.
Manual Graceful shutdowns
When self-hosting, you might want to run code when the server shuts down on SIGTERM
or SIGINT
signals.
You can set the env variable NEXT_MANUAL_SIG_HANDLE
to true
and then register a handler for that signal inside your _document.js
file. You will need to register the env variable directly in the package.json
script, not in the .env
file.
Good to know: Manual signal handling is not available in
next dev
.
{
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "NEXT_MANUAL_SIG_HANDLE=true next start"
}
}
if (process.env.NEXT_MANUAL_SIG_HANDLE) {
// this should be added in your custom _document
process.on('SIGTERM', () => {
console.log('Received SIGTERM: ', 'cleaning up')
process.exit(0)
})
process.on('SIGINT', () => {
console.log('Received SIGINT: ', 'cleaning up')
process.exit(0)
})
}
Was this helpful?