Learn how to install and build Hoppscotch Community Edition.
.env
file in the root directory of the project and add the following environment variables:
DATABASE_URL
: This is where you add your Postgres database URL.HOPP_AIO_ALTERNATE_PORT
: This is an optional variable that lets you specify an alternate port for the AIO container’s endpoint when operating in subpath access mode. By default, this endpoint is exposed on port 80.TOKEN_SALT_COMPLEXITY
: Defines the complexity of the SALT that is used for hashing - a higher number implies a more complex salt.MAGIC_LINK_TOKEN_VALIDITY
: Duration of the validity of the magic link being sent to sign in to Hoppscotch (in days).REFRESH_TOKEN_VALIDITY
: Validity of the refresh token for auth (in ms).ACCESS_TOKEN_VALIDITY
: Validity of the access token for auth (in ms).JWT_SECRET
, SESSION_SECRET
: Secret Keys for security purposes.ALLOW_SECURE_COOKIES
: If disabled users will be able to use Hoppscotch over HTTP connections as well. It is recommended that this be left enabled as some auth providers may not work if this value is set to true.DATA_ENCRYPTION_KEY
: A 32-character key used for encrypting sensitive data stored in the database.REDIRECT_URL
: This is a fallback URL to debug when the actual redirects fail.WHITELISTED_ORIGINS
: URLs of Hoppscotch backend, admin dashboard, frontend app and the bundle server that are allowed to interact with the desktop app.VITE_ALLOWED_AUTH_PROVIDERS
: Allows you to specify which auth providers you want to enable.MAILER_SMTP_ENABLE
: Enables the SMTP mailer configuration.MAILER_USE_CUSTOM_CONFIGS
: When custom mailer configurations are used.MAILER_SMTP_URL
: The SMTP URL for email delivery.MAILER_ADDRESS_FROM
: The email address that you would be using.MAILER_SMTP_HOST
: The SMTP host.MAILER_SMTP_PORT
: The port to connect to the SMTP server.MAILER_SMTP_USER
: The SMTP user or email for authentication.MAILER_SMTP_PASSWORD
: Provide the password set for the SMTP user.RATE_LIMIT_TTL
: The time it takes to refresh the maximum number of requests being received.RATE_LIMIT_MAX
: The maximum number of requests that Hoppscotch can handle under RATE_LIMIT_TTL
.VITE_BASE_URL
: This is the URL where your deployment will be accessible from.VITE_SHORTCODE_BASE_URL
: A URL to generate shortcodes for sharing, can be the same as VITE_BASE_URL
.VITE_BACKEND_GQL_URL
: The URL for GraphQL within the instance.VITE_BACKEND_WS_URL
: The URL for WebSockets within the instance.VITE_BACKEND_API_URL
: The URL for REST APIs within the instance.VITE_APP_TOS_LINK
and VITE_APP_PRIVACY_POLICY_LINK
are optional and are used to configure the links to the Terms & Conditions and Privacy Policy..env
file and the restart policy is mentioned.PORT 3100
in the browser to setup and access the Hoppscotch instance.
.env
file and the restart policy is mentioned.PORT 3100
in the browser to setup and access the Hoppscotch instance.
.env
variable must be set to true, it is set to false by default.
ENABLE_SUBPATH_BASED_ACCESS
to true
in your .env
file.Service | Route |
---|---|
Hoppscotch App | / |
Hoppscotch Admin App | /admin |
Hoppscotch Backend | /backend |
HOPP_AIO_ALTERNATE_PORT
to bind the app to a non-privileged port..env
file containing the right .env
variables for the instance. On executing the aforementioned command will result in a shell being opened inside a instance of the container following which user can execute a database migration normally with
docker compose
to run the services the following command can be used to open a shell inside the backend (or AIO) service.