hoppscotch/hoppscotch

Node.js API

15 environment variables found in .env.example

Set these on your host before deploying. Each platform has an “Environment Variables” section in the deploy flow.

DATABASE_URL secret Backend Config Prisma Config
DATA_ENCRYPTION_KEY secret Sensitive Data Encryption Key while storing in Database (32 character)
WHITELISTED_ORIGINS Whitelisted origins for the Hoppscotch App. This list controls which origins can interact with the app through cross-origin comms.…
PROXY_APP_URL Optional: Default proxy URL offered to clients when proxying is enabled. Clients control whether requests are proxied via the in-app…
TRUST_PROXY If true, the client’s IP address is understood as the left-most entry in the X-Forwarded-For header
VITE_BASE_URL Base URLs
VITE_SHORTCODE_BASE_URL
VITE_ADMIN_URL
VITE_BACKEND_GQL_URL Backend URLs
VITE_BACKEND_WS_URL
VITE_BACKEND_API_URL
VITE_APP_TOS_LINK Terms Of Service And Privacy Policy Links (Optional)
VITE_APP_PRIVACY_POLICY_LINK
VITE_PROXYSCOTCH_ACCESS_TOKEN secret Set default to null as https://proxy.hoppscotch.io/ doesn't require an access token
ENABLE_SUBPATH_BASED_ACCESS Set to `true` for subpath based access

Alternative Fly.io Anything Dockerized — requires the Fly CLI.

macOS

brew install flyctl && fly launch --from https://github.com/hoppscotch/hoppscotch

Linux

curl -L https://fly.io/install.sh | sh && fly launch --from https://github.com/hoppscotch/hoppscotch

Windows (PowerShell)

iwr https://fly.io/install.ps1 -useb | iex; fly launch --from https://github.com/hoppscotch/hoppscotch

Or deploy to a different host