Prerequisites for installing Hoppscotch on your own infrastructure.
Node.js
(v18+) and npm
(v9+).
Verify Node.js and npm installation by running the following commands in your terminal:
pnpm
(v6+).
Verify pnpm installation by running the following command in your terminal:
Docker
(v20+).
Verify Docker installation by running the following command in your terminal:
docker compose
CLI plugin or activate the Use Docker Compose V2 setting in Docker Desktop. For more information, see the Evolution of Compose.
Git
(v2+).
Verify Git installation by running the following command in your terminal:
MAILER_USE_CUSTOM_CONFIGS
to true
, you’ll also need the following details in the specified format:
Requirement | Description | Format |
---|---|---|
SMTP Host | Address of your SMTP server | smtp.customdomain.com |
SMTP Port | Communication port used by your SMTP server | 587 for TLS or 465 for SSL |
SMTP User | Username for your SMTP account | user@customdomain.com |
SMTP Password | Corresponding password for your SMTP account | custompass |
ALLOW_AUDIT_LOGS
environment variable to false
. You can read more about audit logs here.
CALLBACK_URL
variable is the URL that is invoked after the authorization is done and it follows the pattern http://localhost:3170/v1/auth/[auth_provider_name]/callback
.
The 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:
HTTP/s
ports80
and 443
by default, moving forward it is recommended users switch to using these ports. We currently do still support the services being exposed from ports 3000
, 3100
and 3170
respectively but support for this will be dropped in the future and all containers will work over standard HTTP/s ports.