Hoppscotch

Development256MB+ RAM

Open-source API development ecosystem

Download Server Compass View Documentation

apitestingpostman-alternative

Deploy Hoppscotch in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select Hoppscotch

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

CLI Deployment

Deploy Hoppscotch Yourself

Want full control? Here's how to deploy Hoppscotch yourself using Docker Compose.

Remote into Your Server

Initiate a secure shell connection to your server using the command below.

terminal

# Connect to your VPS
ssh root@your-server-ip

# Or with a specific SSH key
ssh -i ~/.ssh/your-key root@your-server-ip

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

Create the App Directory

Organize your deployment by creating a dedicated project folder.

terminal

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

Write Your docker-compose.yml

Create a new docker-compose.yml file and paste this configuration:

docker-compose.yml

services:
  hoppscotch:
    image: hoppscotch/hoppscotch:latest
    ports:
      - "3000:3000"
    environment:
      - DATABASE_URL=postgresql://hoppscotch:<your-db-password>@db:5432/hoppscotch
      - JWT_SECRET=<your-jwt-secret>
      - SESSION_SECRET=<your-session-secret>
    restart: unless-stopped
    depends_on:
      - db

  db:
    image: postgres:16-alpine
    environment:
      - POSTGRES_USER=hoppscotch
      - POSTGRES_PASSWORD=<your-db-password>
      - POSTGRES_DB=hoppscotch
    volumes:
      - postgres_data:/var/lib/postgresql/data
    restart: unless-stopped

volumes:
  postgres_data:

Required Settings

PORTHost port(default: 3000)

JWT_SECRETJWT secret

SESSION_SECRETSession secret

DB_PASSWORDDB password

Launch the Containers

Start the services and tail the logs to verify startup.

terminal

# Spin up containers
docker compose up -d

# Verify deployment
docker compose ps

# Check logs for errors
docker compose logs -f

Open Firewall Ports

Open the required port in your firewall to allow access.

terminal

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

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

Skip the Terminal

Want the easy way? Try Server Compass.

Skip the terminal and deploy Hoppscotch with a visual interface. Configure everything with clicks, not commands.

Visual config editor
Instant deployment
Automatic HTTPS
Smooth updates
Live monitoring
Quick rollbacks

Download Server Compass$29 one-time • Lifetime license

After Deployment

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

Create account

Start testing APIs

Need help? Check out our documentation for detailed guides.

Hoppscotch FAQ

Common questions about self-hosting Hoppscotch

How do I deploy Hoppscotch with Server Compass?

Simply download Server Compass, connect to your VPS, and select Hoppscotch 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 Hoppscotch?

Hoppscotch requires a minimum of 256MB 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 Hoppscotch data?

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

How do I update Hoppscotch to the latest version?

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

Is Hoppscotch free to self-host?

Hoppscotch 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.