Skip to content

Getting Started

Prerequisites

  • Ubuntu 22.04+ VPS with root access
  • At least 1GB RAM, 10GB disk
  • SSH access (port 22 open)
  • Next.js project with a lockfile (package-lock.json, pnpm-lock.yaml, or bun.lockb)

Installation

After purchase, you'll receive an install command via email:

bash
npm install -g exodusdeploy.com/api/download?license=<your-license-key>

Don't have a license?

Get Exodus to receive your install command.

Zero to Deploy

bash
# 1. Connect your VPS (one-time setup)
exodus connect

# 2. Initialize your project
exodus init

# 3. Ship it
exodus deploy

Or run everything in one command:

bash
exodus

Project Structure

After exodus init, you'll have:

your-project/
├── exodus.yml          # Project config
├── .env                # Local env (optional)
└── ...

exodus.yml

yaml
name: my-app
framework: nextjs

build:
  command: pnpm exec next build
  packageManager: pnpm
  node: 24

targets:
  default:
    server: my-vps
    autoDomain: true
    domain: []
    envFiles:
      - .env
    env:
      NODE_ENV: production

INFO

autoDomain: true gives you {project}.{server-ip}.sslip.io instantly. Add custom domains to the domain array.