Neon Local

Database128MB+ RAM

Postgres-compatible local proxy for Neon serverless Postgres projects

Download Server Compass View Documentation

databasesqlneonlocalopen-sourceself-hosteddocker

Deploy Neon Local in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select Neon Local

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

Terminal Deployment

Neon Local CLI Deployment

Deploy Neon Local the traditional way with SSH and Docker Compose.

Start a Secure Shell Session

Open your terminal and connect to your server. Replace the IP address with your VPS IP.

terminal

# SSH into your server
ssh root@your-server-ip

# Using a custom SSH key
ssh -i ~/.ssh/id_rsa root@your-server-ip

First time? Need Docker? Install it: curl -fsSL https://get.docker.com | sh

Prepare Your Workspace

Set up a clean directory for your application.

terminal

# Create and navigate to project directory
mkdir -p ~/apps/neon-local
cd ~/apps/neon-local

Set Up Container Configuration

Set up the container stack using this Docker Compose configuration:

docker-compose.yml

services:
  neon-local:
    image: neondatabase/neon_local:latest
    ports:
      - "5432:5432"
    restart: unless-stopped

Deployment Settings

PORTHost port(default: 5432)

NEON_API_KEYNeon API key

NEON_PROJECT_IDNeon project ID

DELETE_BRANCHDelete branch on stop(default: true)

Bring Up the Application

Launch your application stack in the background.

terminal

# Start the containers in detached mode
docker compose up -d

# Check if containers are running
docker compose ps

# View logs
docker compose logs -f

Configure Firewall

Configure your firewall to permit external connections.

terminal

# Allow the application port through firewall
sudo ufw allow 5432/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:5432

Skip the Terminal

Prefer a visual interface? Use Server Compass.

Server Compass makes deploying Neon Local effortless. Visual setup, one-click deploy, done.

Visual configuration UI
One-click deployment
Automatic SSL setup
Zero-downtime updates
Built-in monitoring
One-click rollbacks

Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying Neon Local with Server Compass, complete these steps to finish setup

Get NEON_API_KEY and NEON_PROJECT_ID from Neon dashboard

Connect with psql or your app using postgres://neon:npg@YOUR_SERVER_IP:{{PORT}}/neondb?sslmode=require

For persistent preview branches, set DELETE_BRANCH=false

Need help? Check out our documentation for detailed guides.

Neon Local FAQ

Common questions about self-hosting Neon Local

How do I deploy Neon Local with Server Compass?

Simply download Server Compass, connect to your VPS, and select Neon Local from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Neon Local?

Neon Local requires a minimum of 128MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Neon Local data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Neon Local backup and restore procedures.

How do I update Neon Local to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Neon Local image will be pulled and deployed with zero downtime.

Is Neon Local free to self-host?

Neon Local is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.