Deploy Hoppscotch

Open-source API client for REST, GraphQL and WebSocket, with Postgres

Deploy Hoppscotch

Just deployed

/data

/var/lib/postgresql/data

Just deployed

/data

Deploy and Host Hoppscotch on Railway

Hoppscotch is an open-source API development platform and a lightweight alternative to Postman. You build, send and test REST, GraphQL, WebSocket, SSE, Socket.IO and MQTT requests from the browser. Requests, collections, environments and history are saved, and team workspaces let several people share collections.

About Hosting Hoppscotch

The self-hosted edition has three parts: the web app, an admin dashboard and a NestJS backend that stores everything in PostgreSQL. Sign-in uses e-mail magic links or OAuth (GitHub, Google, Microsoft). This template runs the official all-in-one image on one Railway domain: the app on /, the admin dashboard on /admin and the API on /backend. The start command applies database migrations, then finishes the first-run onboarding before the app starts: it turns on e-mail sign-in through a bundled Mailpit inbox and makes your ADMIN_EMAIL the administrator. A fresh URL can't be claimed by anyone else, and you need no outside mail service to sign in.

Common Use Cases

  • Send and debug REST, GraphQL and WebSocket requests while building an API
  • Share collections, environments and saved requests with your team in one workspace
  • Run collections as automated API tests from CI with the Hoppscotch CLI

Dependencies for Hoppscotch Hosting

  • PostgreSQL (Railway Postgres) for users, collections, teams and settings
  • Mailpit, a small mail catcher that receives the sign-in links until you add a real SMTP server

Deployment Dependencies

Implementation Details

First sign-in

  1. Enter your e-mail as ADMIN_EMAIL when you deploy. It's the only required input.
  2. Open the Hoppscotch URL and sign in with that address.
  3. Open the Mailpit URL and log in with the MAILPIT_USERNAME and MAILPIT_PASSWORD shown in the Mailpit service's variables. Click the link in the "Sign in to Hoppscotch" mail.
  4. The admin dashboard is at https:///admin.

Who can sign in: magic links only reach the password-protected Mailpit inbox, so only you can sign in at first. To let your team in, open the admin dashboard's Settings page and set up your own SMTP server or an OAuth provider (GitHub, Google or Microsoft). Once you do, anyone who can sign in that way can create an account. You can then remove the Mailpit service.

Restarts are normal: Hoppscotch restarts its backend after the first boot and after every settings change in the admin dashboard. The start script starts it again within a few seconds.

Custom domain: if you add one, replace the generated domain in WHITELISTED_ORIGINS and the VITE_* URL variables of the Hoppscotch service.

Running collections from CI: create a personal access token in your profile, then run npx @hoppscotch/cli test --token --server https:///backend.

Why Deploy Hoppscotch on Railway?

Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it.

By deploying Hoppscotch on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway.


Template Content

More templates in this category

View Template
Rocky Linux
Hosted Rocky Linux 9 workspace with SSH and persistent storage. 🚀

codestorm
51
View Template
Foundry Virtual Tabletop
A Self-Hosted & Modern Roleplaying Platform

Lucas
71
View Template
Letta Code Remote
Run a Letta Code agent 24/7. No inbound ports, just deploy.

Letta
52