Hoppscotch Desktop App ^ALPHA

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

Now with the ability to connect to Self-Hosted instances

Installation

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.

Using Homebrew

You can use Homebrew (on macOS or Linux) to install Hoppscotch

brew install --cask hoppscotch

Access Options

Hoppscotch Cloud Edition for Individuals

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.

Self-Hosted Edition (Community and 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.

bashCopy

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

To connect to your self-hosted (community or enterprise) instance:

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:

Copy

❯ 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.

Building and Self-Hosting Hoppscotch Desktop

You can also build Hoppscotch Desktop locally to self-host with on-prem infra:

1. Install and generate the selfhost web app:
   bashCopy

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

2. Build the webapp-bundler:
   bashCopy

   cd crates/webapp-bundler
   cargo build --release
   

3. Bundle the web app:
   bashCopy

   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 development server:
   bashCopy

   cd hoppscotch-desktop
   pnpm tauri dev
   

   or the following for production build:
   bashCopy

   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.

Minimum System Requirements

Windows

• OS Version: Windows 10 1803+ or Windows 11
• Architecture: x64

macOS

• OS Version: macOS 10.15 (Catalina) or later
• Architecture: Intel x64 or Apple Silicon (ARM64)

Linux

• Architecture: x64
• Recommended OS: Ubuntu 24.04 or newer (or similar flavor of distros)
• Minimum: Systems with GLIBC 2.38+

Why Ubuntu 24.04-like flavors or newer?

Ubuntu 24.04-like flavors ships with the exact WebKit2GTK version (2.44.0-2) that is stable enough to correctly handle interaction between WebKit, UI libraries, Mesa drivers, and Wayland displays.¹²³

[!IMPORTANT] There may be some display oddities on Wayland systems caused by the interaction between WebKit and the underlying graphics drivers.⁴⁵⁶

Workaround:

bashCopy

WEBKIT_DISABLE_COMPOSITING_MODE=1 hoppscotch
# or
WEBKIT_DISABLE_DMABUF_RENDERER=1 hoppscotch
# or both together

Misc.

• Older distributions: The AppImage requires GLIBC 2.38+ ¹⁷
  • Users on older systems will see GLIBC version errors like "GLIBC_2.32' not found"⁸
• Tauri v2 dependency: The desktop app requires libwebkit2gtk-4.1, which is only available by default in Ubuntu 22.04+ repositories⁹
• Build from source: GitHub workflow for building from source¹⁰

Sources