|Docs

Deploy a Next.js App

deploymentnextjsreactfullstack

Next.js is a React framework for building full-stack web applications. It handles server-side rendering, static generation, API routes, and routing.

This guide covers how to deploy a Next.js app to Railway in four ways:

  1. One-click deploy from a template.
  2. From a GitHub repository.
  3. Using the CLI.
  4. Using a Dockerfile.

Create a Next.js App

Note: If you already have a Next.js app locally or on GitHub, you can skip this step and go straight to Deploy the Next.js App to Railway.

To create a new Next.js app, ensure that you have Node installed on your machine.

Run the following command in your terminal to create a new Next.js app:

Follow the prompts to configure your app. The defaults work well for most projects.

Run the Next.js App locally

cd into the directory and start the development server:

Open your browser and go to http://localhost:3000 to see your app.

Deploy the Next.js App to Railway

Railway offers multiple ways to deploy your Next.js app, depending on your setup and preference.

One-Click Deploy from a Template

If you're looking for the fastest way to get started, the one-click deploy option is ideal.

Click the button below to begin:

Deploy on Railway

We highly recommend that you eject from the template after deployment to create a copy of the repo on your GitHub account.

Note: You can also choose from a variety of Next.js app templates created by the community.

Deploy from the CLI

  1. Install the Railway CLI:

  2. Initialize a Railway Project:

    • Run the command below in your Next.js app directory.
    • Follow the prompts to name your project.
    • After the project is created, click the provided link to view it in your browser.

  3. Configure for Standalone Output:

    Next.js needs to produce a standalone build for self-hosted deployment. Add the output option to your next.config.ts (or next.config.js) file:

    next.config.ts

    Then update the start script in package.json to serve the standalone server:

    package.json

    Note: Railway uses Railpack (or Nixpacks) to build and deploy your code with zero configuration. The Node provider will pick up the start script in package.json and use it to serve the app.

  4. Deploy the Application:

    • Use the command below to deploy your app:
    • This command will scan, compress and upload your app's files to Railway. You'll see real-time deployment logs in your terminal.
    • Once the deployment completes, go to View logs to check if the service is running successfully.

  5. Set Up a Public URL:

    • Navigate to the Networking section under the Settings tab of your new service.
    • Click Generate Domain to create a public URL for your app.

Deploy from a GitHub Repo

To deploy a Next.js app to Railway directly from GitHub, follow the steps below:

  1. Create a New Project on Railway:
    • Go to Railway to create a new project.
  2. Configure for Standalone Output:
  3. Deploy from GitHub:
    • Select Deploy from GitHub repo and choose your repository.
      • If your Railway account isn't linked to GitHub yet, you'll be prompted to do so.
  4. Deploy the App:
    • Click Deploy to start the deployment process.
    • Once deployed, a Railway service will be created for your app, but it won't be publicly accessible by default.
  5. Verify the Deployment:
    • Once the deployment completes, go to View logs to check if the server is running successfully.
  6. Set Up a Public URL:
    • Navigate to the Networking section under the Settings tab of your new service.
    • Click Generate Domain to create a public URL for your app.

Use a Dockerfile

  1. Create a Dockerfile in your Next.js app's root directory.

  2. Add the content below to the Dockerfile:

    Note: This Dockerfile requires output: "standalone" in your next.config.ts as described in step 3 of the CLI guide.

  3. Either deploy via the CLI or from GitHub.

Railway automatically detects the Dockerfile, and uses it to build and deploy the app.

Note: Railway also supports deployment from public and private Docker images.

This guide covers the main deployment options on Railway. Choose the approach that suits your setup, and start deploying your Next.js apps seamlessly!

Next Steps

Explore these resources to learn how you can maximize your experience with Railway: