api-client/packages/hoppscotch-desktop

Hoppscotch Desktop App ^ALPHA

Hoppscotch Desktop

Download | Official Docs

Hoppscotch Desktop App is a cross-platform Hoppscotch app built with Tauri V2

Now with the ability to connect to Self-Hosted instances

Install Hoppscotch Desktop App

1. Download the latest version of Hoppscotch Desktop App
2. Open the downloaded file.
3. Follow the on-screen instructions to install Hoppscotch Desktop App.
4. Open Hoppscotch Desktop App.

Access Hoppscotch

Hoppscotch Cloud Edition for Individuals

Access Hoppscotch Cloud Edition from Hoppscotch Desktop App:

1. Open Hoppscotch Desktop App.
2. Click the Hoppscotch logo in the top-left corner.
3. Click "HOPPSCOTCH CLOUD".
4. Sign in with your Hoppscotch Cloud account to access your workspaces and collections.

Hoppscotch Self-Hosted Edition for Community

Note

To enable desktop app support for your self-hosted Hoppscotch instance, make sure to update the WHITELISTED_ORIGINS environment variable in your .env file with your deployment URL.

e.g. to allow connection to https://hoppscotch.mydomain.com you need to add app://hoppscotch_mydomain_com (MacOS, Linux) and http://app.hoppscotch_mydomain_com (Windows) to the WHITELISTED_ORIGINS environment variable.

WHITELISTED_ORIGINS=...existing_origins,app://hoppscotch_mydomain_com,http://app.hoppscotch_mydomain_com

Add your self-hosted Hoppscotch Community Edition instance to Hoppscotch Desktop App:

1. Open Hoppscotch Desktop App.
2. Click the Hoppscotch logo in the top-left corner.
3. Click "Add an instance".
4. Enter the URL of your self-hosted Hoppscotch instance.
5. Click "Connect".

Tip

You can also self-host Hoppscotch Desktop App.

1. Install and generate the selfhost web app:

   cd ../hoppscotch-selfhost-web
   pnpm install
   pnpm generate
   

2. Build the webapp bundler:

   cd crates/webapp-bundler
   cargo build --release
   

3. Bundle the web app:

   cd target/release
   ./webapp-bundler --input [path-to-dist-directory] --output [path-to-hoppscotch-desktop]/bundle.zip --manifest [path-to-hoppscotch-desktop]/manifest.json
   

4. Run the Tauri development server:

   cd src-tauri
   pnpm tauri dev
   

   or the following for production build:

   cd src-tauri
   pnpm tauri dev
   

Note

[path-to-dist-directory] should point to the dist directory created by the pnpm generate command in step 1.

Hoppscotch Self-Hosted Edition for Enterprise

Note

To enable desktop app support for your self-hosted Hoppscotch instance, make sure to update the WHITELISTED_ORIGINS environment variable in your .env file with your deployment URL.

e.g. to allow connection to https://hoppscotch.mydomain.com you need to add app://hoppscotch_mydomain_com (MacOS, Linux) and http://app.hoppscotch_mydomain_com (Windows) to the WHITELISTED_ORIGINS environment variable.

WHITELISTED_ORIGINS=...existing_origins,app://hoppscotch_mydomain_com,http://app.hoppscotch_mydomain_com

Add your self-hosted Hoppscotch Enterprise Edition instance to Hoppscotch Desktop App:

1. Open Hoppscotch Desktop App.
2. Click the Hoppscotch logo in the top-left corner.
3. Click "Add an instance".
4. Enter the URL of your self-hosted Hoppscotch instance.
5. Click "Connect".

Note

For docker setup, the desktop app uses a server at port 3200, and it is part of the frontend container:

❯ docker run -p 3000:3000 -p 3200:3200 hoppscotch/hoppscotch-frontend

Once the container is live, you can enter [your-ip]:3200 or simply the base address of the instance if you are using subpath access.