Configuration Guide

Complete reference for nextdeploy.yml configuration.

Core Target Configuration

version: 1.0
target_type: "vps" # Choose "vps" or "serverless"
app:
  name: my-app
  environment: production
  domain: app.example.com
FieldTypeRequiredDescription
namestringUnique identifier for your app
environmentstringDeployment environment
domainstring⚠️Required for HTTPS setup
portnumberPort your Next.js app listens on

AWS Serverless Target

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

Required Environment Variables

AWS_ACCESS_KEY_ID=your-key
AWS_SECRET_ACCESS_KEY=your-secret

Linux VPS Target

target_type: "vps"
servers:
  - host: 192.168.1.100         # VPS IP address
    ssh_key: "~/.ssh/id_rsa"    # Path to local SSH Config Key

Symlink Architecture Options

deployment:
  keep_releases: 5     # Number of old deployments to keep on disk for rollbacks

Environment-Specific Configs

Create multiple config files:

nextdeploy.yml           # Default (development)
nextdeploy.staging.yml   # Staging
nextdeploy.prod.yml      # Production

Use with:

nextdeploy build --config nextdeploy.prod.yml

Validation

Validate your configuration:

nextdeploy validate