Set up Hoppscotch on your servers for complete control and customization.
.env
file in your working directory, copy the example environment variable configurations provided below into it, and then replace the example values with your actual values.
=
). DATABASE_URL
variable in your .env
file with your custom database connection string, which should include the username, password, and database name.
docker run
with the appropriate port mappings (1080
for the web interface and 1025
for SMTP).
Docker containers are isolated from the host by default. When using localhost inside a Docker container, it refers to the container itself, and not the host machine. Since Hoppscotch runs inside a Docker container while Mailcatcher runs on the host machine, you’ll need to use the Docker bridge network IP instead oflocalhost
to ensure that the containerized application can communicate with the Mailcatcher service on the host. To find this IP address, run:Look for the inet address associated with the docker0 interface. It’s typically in the 172.17.0.0/16 range but may vary based on your Docker network configuration. And If you’re using Docker Desktop, you can usehost.docker.internal
instead oflocalhost
.
http://<Docker_bridge_IP or host.docker.internal>:1080
to access the Mailcatcher web interface and view email communications.
Further, configure the below environment variables in your .env
file:
MAILER_USE_CUSTOM_CONFIGS=true
. You can choose from services like SendGrid, Amazon SES, or your own SMTP server. Once you’ve set up your chosen service, update your .env
file with the following details:
ENABLE_SUBPATH_BASED_ACCESS=true
, you can access all three services (Hoppscotch App, Admin Dashboard, Hoppscotch Backend) on the same domain using different routes. If subpath access is disabled (ENABLE_SUBPATH_BASED_ACCESS=false
), you will need to access the services on different ports.
HOPP_AIO_ALTERNATE_PORT
to bind the app to a non-privileged port.Check Database Connectivity
DATABASE_URL
specified in your .env
file.Select the suitable Hoppscotch instance to self-host
Pull the latest Hoppscotch container
Run Database Migrations
Start the Hoppscotch Instance
http://localhost:3100
if ENABLE_SUBPATH_BASED_ACCESS=false
.http://localhost:3000
.