thibaud-lclr/api-client
1
0
Fork 0
Code Packages Activity Actions
api-client/packages/hoppscotch-desktop
History
Shreyas fbeb0e56be
feat(desktop): file-based logs with rotation (#5009) 
This PR adds a file-based logging system with size-based rotation to the desktop application. It essentially redirects existing diagnostic to size-based rotating files for troubleshooting environment-specific issues.

Closes HFE-801

The desktop application currently lacks a persistent logging mechanism in production environments. Logs are only available through the development mode console.

This PR will help diagnose issues reported in #4859, #4950, #5003, discussions #4984 and #4986.

Mainly aiming to understand errors in specific environments that can't be reproduced in our testing setups.

This implementation uses the tracing ecosystem (`tracing`, `tracing_subscriber`, `tracing_appender`) along with `file_rotate` to create log files in the platform's log directory. The logs are automatically rotated when they reach `10MB`, with a maximum of `5` files retained.

Thinking 10 * 5 MB is reasonable disk usage while maintaining sufficient history.

The system currently writes to both the console (with ANSI colors where supported) and to files (without ANSI formatting for readability). Log levels are currently controlled via the `RUST_LOG` environment variable, defaulting to "debug" when not specified.

| OS      | Log File Path                                        |
|---------|------------------------------------------------------|
| Windows | `C:\Users\<username>\AppData\Local\io.hoppscotch.desktop\logs\io.hoppscotch.desktop.log` |
| macOS   | `~/Library/Logs/io.hoppscotch.desktop/io.hoppscotch.desktop.log` |
| Linux   | `~/.local/share/io.hoppscotch.desktop/logs/io.hoppscotch.desktop.log` |
2025-04-25 17:09:51 +05:30
..
crates/webapp-bundler feat: platform independent core and the new desktop app (#4684) 2025-02-28 00:01:25 +05:30
plugin-workspace fix(desktop): disk space detection (#5019) 2025-04-25 16:57:37 +05:30
public feat: platform independent core and the new desktop app (#4684) 2025-02-28 00:01:25 +05:30
src fix: resolve typos across packages (#4867) 2025-03-12 13:53:08 +05:30
src-tauri feat(desktop): file-based logs with rotation (#5009) 2025-04-25 17:09:51 +05:30
.gitignore feat: platform independent core and the new desktop app (#4684) 2025-02-28 00:01:25 +05:30
connection-to-self-hosted-instance.png docs(desktop): update README (#4864) 2025-03-10 22:46:15 +05:30
desktop-app.png docs(desktop): update README (#4864) 2025-03-10 22:46:15 +05:30
index.html feat: platform independent core and the new desktop app (#4684) 2025-02-28 00:01:25 +05:30
package.json chore: bump version to 2025.3.2 2025-04-15 13:16:56 +05:30
postcss.config.js feat: platform independent core and the new desktop app (#4684) 2025-02-28 00:01:25 +05:30
README.md docs(desktop): include windows specific caveats (#4884) 2025-03-13 16:25:25 +05:30
tailwind.config.ts feat: platform independent core and the new desktop app (#4684) 2025-02-28 00:01:25 +05:30
tsconfig.json feat: platform independent core and the new desktop app (#4684) 2025-02-28 00:01:25 +05:30
tsconfig.node.json feat: platform independent core and the new desktop app (#4684) 2025-02-28 00:01:25 +05:30
vite.config.ts fix(desktop): cache size for larger bundles, dev server, lints (#4796) 2025-02-28 22:18:51 +05:30

README.md

Hoppscotch Desktop App ALPHA

Hoppscotch Desktop

Download | Official Docs


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

Hoppscotch Desktop App

Now with the ability to connect to Self-Hosted instances

Hoppscotch Desktop App

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.