Hoppscotch is a self-hosted API development platform, packaged as a set of Docker containers. You can install and run Hoppscotch on any operating system that can run a Docker Engine. You can use Hoppscotch on your local machine or a cloud provider of your choice.
Hoppscotch is designed to run well on both small and large deployments. The minimum requirements to run Hoppscotch are an operating system that supports Docker and 4 CPU cores + 4GB of RAM to generate the build image and as little as 1 CPU core + 2GB of RAM to host the generated output files.
Verify Node.js and npm installation by running the following commands in your terminal:
Verify pnpm installation by running the following command in your terminal:
Verify Docker installation by running the following command in your terminal:
It is recommended to use Compose V2. To switch to Compose V2, use the
docker compose CLI plugin or activate the Use Docker Compose V2 setting in Docker Desktop. For more information, see the Evolution of Compose.
Verify Git installation by running the following command in your terminal:
Hoppscotch comes with support for easy integrations with 3rd party SMTP providers. You will need emails so that you can invite your team to use Hoppscotch and for emails to work, you will need to set up proper SMTP configuration as described below.
To enable email delivery, you will need to generate a valid SMTP URL in the below format:
For example, if you are using Gmail as your SMTP server your SMTP URL will look like something shown below:
You can also use mailcatcher as a simple SMTP server
Hoppscotch uses a Postgres database to store all the data. You can use any Postgres database provider of your choice - hosted locally or on a cloud provider. Make sure you have a valid Postgres database URL in the below format:
You also need to configure an OAuth provider to enable third-party authentication. Hoppscotch supports the following OAuth providers:
Hoppscotch provides you with the ability to choose which authentication providers you want to use in the app. You can do this by specifying the required providers in the environment variable
To configure the third-party authentication, you will need to generate a valid OAuth client ID and client secret for the OAuth provider of your choice. You will also need to provide a valid callback URL for the OAuth provider.
For example, if you are using GitHub as your OAuth provider, you will need to generate a valid OAuth client ID and client secret for GitHub. You will also need to provide a valid callback URL for GitHub. The environment variables for the GitHub OAuth provider will look like something shown below:
GITHUB_CLIENT_ID="*****" GITHUB_CLIENT_SECRET="*****" GITHUB_CALLBACK_URL="http://localhost:3170/auth/github/callback" GITHUB_SCOPE="user:email"
CALLBACK_URL variable is the URL that is invoked after the authorization is done and it follows the pattern
SCOPE variable defines the scope of the data that the OAuth provider passes on to Hoppscotch.
The links to configure OAuth for various providers are given below:
- It is recommended that you secure your deployments by issuing TLS certificates and using HTTPS since we use secure HTTP cookies for authenticating users.