1
Step 1Open the server Apps tab
Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.
Back to all templates
Hoppscotch
Development256MB+ RAM
Open-source API development ecosystem
apitestingpostman-alternative
Deploy Hoppscotch in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select Hoppscotch
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy Hoppscotch on a VPS with Server Compass
Use the Hoppscotch template in Server Compass to deploy a self-hosted API development workspace with PostgreSQL on your VPS, then verify the Hoppscotch web app in a browser.
About 10 minutesBrowser verified
2
Step 2Choose an app template
Click New App and choose the template deployment path so Server Compass can load the built-in catalog.
3
Step 3Search for Hoppscotch
Use the template picker search to find Hoppscotch in the Server Compass template catalog.
4
Step 4Select the Hoppscotch template
Choose the Hoppscotch template. Server Compass fills the Hoppscotch service, migration job, PostgreSQL service, public URL settings, JWT secret, session secret, data encryption key, and database password.
5
Step 5Review the Hoppscotch settings
Confirm the app name and compose services. In this run, the app was named hoppscotch-demo and used host port 3000.
6
Step 6Deploy Hoppscotch
Review the generated environment values, keep generated secrets masked, confirm the public URL and WebSocket URL match the resolved port, and click Deploy Now.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the Hoppscotch and PostgreSQL images, starts the containers, and verifies the stack.
8
Step 8Confirm Hoppscotch is running
After deployment finishes, return to the Apps tab and confirm the Hoppscotch app is marked Running with its application URL available.
9
Step 9Open Hoppscotch in the browser
Click Open Application or open the application URL in a browser. The Hoppscotch web app confirms the deployed API workspace is reachable and ready for final setup.
After Hoppscotch Opens
- Create the first workspace account before production use.
- Store the generated JWT, session, and database secrets in a secure password manager.
- Keep generated secrets masked in screenshots and docs.
- Add a domain and HTTPS before inviting users or storing real API collections.
- Configure teams, auth providers, and environment variables before production use.
- Back up the Hoppscotch PostgreSQL data volume.
Hoppscotch deployment questions
What does the Hoppscotch template deploy?
It deploys Hoppscotch in AIO subpath mode with a one-shot Prisma migration job, PostgreSQL 16, generated JWT/session/data-encryption secrets, and a public URL that matches the resolved host port.
Which port did the tutorial use?
The tutorial used host port 3000, which maps to the Hoppscotch web UI on container port 3000.
Why does the browser verification stop at the first loaded web app screen?
A fresh Hoppscotch deployment is considered reachable when the web app loads. Account creation, auth providers, teams, and collections are environment-specific.
Should this become a blog post?
No. The deployment guide should live on the Hoppscotch template detail page and be linked from the reusable template deployment docs page.
CLI Deployment
Deploy Hoppscotch Yourself
Want full control? Here's how to deploy Hoppscotch yourself using Docker Compose.
1
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-ipFirst time? Docker required! Install it with: curl -fsSL https://get.docker.com | sh
2
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/hoppscotch3
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 secretSESSION_SECRETSession secretDB_PASSWORDDB password4
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 -f5
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:3000Skip 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
1
Create account
2
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.
Related Templates
View all Development
PocketBase
Open-source backend in a single file with realtime database, auth, and file storage
Appwrite
Open-source backend-as-a-service - self-hosted Firebase alternative
Parse Server
Open-source backend framework with dashboard
Supabase
Full Supabase self-hosted with Kong, GoTrue Auth, Realtime, and Studio
Ready to Self-Host Hoppscotch?
Download Server Compass and deploy Hoppscotch to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass