Getting Started with NextDeploy

Welcome to NextDeploy! This guide will help you deploy your first Next.js application in under 5 minutes.

What is NextDeploy?

NextDeploy is a self-hosted deployment platform built exclusively for Next.js applications. Think of it as your own personal Vercel, but with:

  • ✓Full control - Deploy to any VPS you own
  • ✓Native Execution - Run Next.js bare-metal, no overhead
  • ✓Zero lock-in - No vendor dependencies
  • ✓Serverless Ready - Deploy natively to AWS Lambda/S3
  • ✓Transparent - See every step of the deployment
  • ✓Cost-effective - Pay only for your VPS ($5-20/month)

Prerequisites

Before you begin, make sure you have:

  • •A Next.js project (any version)
  • •A VPS Server (for Linux targets) OR an AWS Account (for Serverless targets)
  • •SSH access to your server

Installation

CLI (All Platforms)

Install the NextDeploy CLI using webi:

curl https://webi.sh/nextdeploy | sh

Or download directly from GitHub Releases.

Daemon (Linux Servers Only)

On your VPS, install the daemon:

curl https://webi.sh/nextdeployd | sh
sudo systemctl enable nextdeployd
sudo systemctl start nextdeployd

Quick Start

1. Initialize Your Project

Navigate to your Next.js project and run:

cd my-nextjs-app
nextdeploy init

This creates:

  • • nextdeploy.yml - Main Configuration file
  • • .nextdeploy/metadata.json - Cached route breakdown

2. Configure Deployment

Edit nextdeploy.yml for your desired target:

For AWS Serverless:

version: "1.0"
target_type: "serverless"
serverless:
  provider: "aws"
  region: "us-east-1"
  s3_bucket: "my-nextjs-assets"

For Linux VPS:

version: "1.0"
target_type: "vps"
servers:
  - host: 192.168.1.100
    ssh_key: "~/.ssh/id_rsa"

3. Generate CI Pipeline (Optional)

Want Zero-Touch shipping? Generate a GitHub Action instantly:

nextdeploy generate-ci

4. Deploy (The Act of Shipping)

nextdeploy build
nextdeploy deploy

This will securely execute your deployment:

  • • VPS: Extracts bundle to release/ and performs a zero-downtime port swap.
  • • Serverless: Syncs static assets to S3 and wraps logic in the AWS Lambda Web Adapter.

Next Steps

PreviousIntroduction
NextInstallation