[GH-ISSUE #3523] [feature]: Hoppscotch self-hosted instance support in desktop app #1195

Closed
opened 2026-03-16 19:06:15 +03:00 by kerem · 27 comments
Owner

Originally created by @baek-sang on GitHub (Nov 9, 2023).
Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/3523

Originally assigned to: @CuriousCorrelation on GitHub.

Is there an existing issue for this?

  • I have searched the existing issues

Summary

Allows you to enter own domain to synchronize workspace

Why should this be worked on?

Work continuously from home to work

Originally created by @baek-sang on GitHub (Nov 9, 2023). Original GitHub issue: https://github.com/hoppscotch/hoppscotch/issues/3523 Originally assigned to: @CuriousCorrelation on GitHub. ### Is there an existing issue for this? - [X] I have searched the existing issues ### Summary Allows you to enter own domain to synchronize workspace ### Why should this be worked on? Work continuously from home to work
kerem 2026-03-16 19:06:15 +03:00
Author
Owner

@giosueDelgado commented on GitHub (Jan 12, 2024):

Need this also us!

<!-- gh-comment-id:1888882962 --> @giosueDelgado commented on GitHub (Jan 12, 2024): Need this also us!
Author
Owner

@alaegin commented on GitHub (Mar 10, 2024):

I hope this will be implemented!

<!-- gh-comment-id:1987160484 --> @alaegin commented on GitHub (Mar 10, 2024): I hope this will be implemented!
Author
Owner

@thetronjohnson commented on GitHub (Apr 1, 2024):

We do have this in our plans, the current priority is to get the desktop app out of alpha into a stable release, I'll respond back with a timeline once we release a stable release for the desktop app (expecting this to happen by end of may)

<!-- gh-comment-id:2029782348 --> @thetronjohnson commented on GitHub (Apr 1, 2024): We do have this in our plans, the current priority is to get the desktop app out of alpha into a stable release, I'll respond back with a timeline once we release a stable release for the desktop app (expecting this to happen by end of may)
Author
Owner

@domints commented on GitHub (May 13, 2024):

+1 from my side, it would be awesome, since proxyscotch is... a little bit wonky to use.
It feels like it's possible to do it with some config files, but it might require building your own copy of the app? I am not sure since I am not too fluent in this concept of web app that's pretending to be a desktop app :)

<!-- gh-comment-id:2107239846 --> @domints commented on GitHub (May 13, 2024): +1 from my side, it would be awesome, since proxyscotch is... a little bit wonky to use. It feels like it's possible to do it with some config files, but it might require building your own copy of the app? I am not sure since I am not too fluent in this concept of web app that's pretending to be a desktop app :)
Author
Owner

@Coniface commented on GitHub (Jun 22, 2024):

@thetronjohnson as the lastest release mentions improvements on the self hosted version and the Desktop app, does that mean that this issue is no longer relevant and self-hosting is now compatible with the Desktop App?

<!-- gh-comment-id:2184162494 --> @Coniface commented on GitHub (Jun 22, 2024): @thetronjohnson as the lastest release mentions improvements on the self hosted version and the Desktop app, does that mean that this issue is no longer relevant and self-hosting is now compatible with the Desktop App?
Author
Owner

@baek-sang commented on GitHub (Jun 23, 2024):

@thetronjohnson You said the end of May, and now it's the end of June. Is there any other news?

<!-- gh-comment-id:2184821613 --> @baek-sang commented on GitHub (Jun 23, 2024): @thetronjohnson You said the end of May, and now it's the end of June. Is there any other news?
Author
Owner

@christianhaessler commented on GitHub (Jul 3, 2024):

Seems not to work in newest version: v2024.6.0. Are there any updates?

<!-- gh-comment-id:2205588463 --> @christianhaessler commented on GitHub (Jul 3, 2024): Seems not to work in newest version: v2024.6.0. Are there any updates?
Author
Owner

@marcusthelin commented on GitHub (Sep 9, 2024):

Any progress? @thetronjohnson

<!-- gh-comment-id:2337382205 --> @marcusthelin commented on GitHub (Sep 9, 2024): Any progress? @thetronjohnson
Author
Owner

@liyasthomas commented on GitHub (Sep 25, 2024):

Reopening this issue for continued tracking as it was unintentionally closed. This is still relevant for further discussion/implementation. Thank you!

<!-- gh-comment-id:2373068107 --> @liyasthomas commented on GitHub (Sep 25, 2024): Reopening this issue for continued tracking as it was unintentionally closed. This is still relevant for further discussion/implementation. Thank you!
Author
Owner

@FerreiraAdrien commented on GitHub (Oct 29, 2024):

Would love to see this features in the desktop app. Any news or delay ?

<!-- gh-comment-id:2443967032 --> @FerreiraAdrien commented on GitHub (Oct 29, 2024): Would love to see this features in the desktop app. Any news or delay ?
Author
Owner

@wapmorgan commented on GitHub (Nov 21, 2024):

I think it's not an important for hoppsctoch team because it can decrease number of cloud users(=licenses)

<!-- gh-comment-id:2490948533 --> @wapmorgan commented on GitHub (Nov 21, 2024): I think it's not an important for hoppsctoch team because it can decrease number of cloud users(=licenses)
Author
Owner

@liyasthomas commented on GitHub (Nov 21, 2024):

This feature is extremely important to the Hoppscotch team.

However, implementing it poses significant technical challenges. Self-hosted instances depend on a variety of user configurations, making it complex to ensure seamless support across all scenarios. Developing a desktop app that works universally for all self-hosted setups requires substantial engineering effort and careful consideration.

That said, we’ve been actively working on prototypes internally to validate the feasibility of this feature. We're currently in the testing phase to ensure the solution is robust and works effectively for users worldwide.

Your patience and understanding are greatly appreciated as we strive to make this possible. Stay tuned for updates!

<!-- gh-comment-id:2490975152 --> @liyasthomas commented on GitHub (Nov 21, 2024): This feature is extremely important to the Hoppscotch team. However, implementing it poses significant technical challenges. Self-hosted instances depend on a variety of user configurations, making it complex to ensure seamless support across all scenarios. Developing a desktop app that works universally for all self-hosted setups requires substantial engineering effort and careful consideration. That said, we’ve been actively working on prototypes internally to validate the feasibility of this feature. We're currently in the testing phase to ensure the solution is robust and works effectively for users worldwide. Your patience and understanding are greatly appreciated as we strive to make this possible. Stay tuned for updates!
Author
Owner

@domints commented on GitHub (Nov 21, 2024):

I believe adding textbox that would let input backend url in, even if it could complain that the backend is in incompatible version or sth would already solve most of the problems, and then you could spend time on refining the edge cases (or ignore them saying user is the problem and that would be fine too)

<!-- gh-comment-id:2490984480 --> @domints commented on GitHub (Nov 21, 2024): I believe adding textbox that would let input backend url in, even if it could complain that the backend is in incompatible version or sth would already solve most of the problems, and then you could spend time on refining the edge cases (or ignore them saying user is the problem and that would be fine too)
Author
Owner

@liyasthomas commented on GitHub (Nov 21, 2024):

Adding to my previous comment, another key consideration is that organizations often have their own unique methods for securing API requests to their backend systems. These can include using proxies, implementing strict site protection rules that limit third-party access, or even completely restricting public internet access to self-hosted instances of Hoppscotch.

These variations introduce additional layers of complexity in ensuring compatibility and usability for all potential setups. Our goal is to create a solution that works seamlessly across such diverse configurations, which is why we’re being thorough in our approach. Thanks again for your understanding and support!

<!-- gh-comment-id:2490997007 --> @liyasthomas commented on GitHub (Nov 21, 2024): Adding to my previous comment, another key consideration is that organizations often have their own unique methods for securing API requests to their backend systems. These can include using proxies, implementing strict site protection rules that limit third-party access, or even completely restricting public internet access to self-hosted instances of Hoppscotch. These variations introduce additional layers of complexity in ensuring compatibility and usability for all potential setups. Our goal is to create a solution that works seamlessly across such diverse configurations, which is why we’re being thorough in our approach. Thanks again for your understanding and support!
Author
Owner

@domints commented on GitHub (Nov 21, 2024):

Isn’t that „them” problem? How can you even ensure compatibility with such things?
You can add HTTP proxy support, if whatever you’re using in desktop app doesn’t inherit system settings, and that’s all. Maybe add extra auth options, but then it would be the case with web app too. It’s not like you’re implementing GlobalProtect or whatever VPN solutions are there on the market?

I’m sorry, Thomas, but this explanation feels dishonest. You must remember, that here you’re speaking to tech people who understand the technicalities. If your approach is to avoid implementing this, sure, that’s fine, just be honest about it.

<!-- gh-comment-id:2491012951 --> @domints commented on GitHub (Nov 21, 2024): Isn’t that „them” problem? How can you even ensure compatibility with such things? You can add HTTP proxy support, if whatever you’re using in desktop app doesn’t inherit system settings, and that’s all. Maybe add extra auth options, but then it would be the case with web app too. It’s not like you’re implementing GlobalProtect or whatever VPN solutions are there on the market? I’m sorry, Thomas, but this explanation feels dishonest. You must remember, that here you’re speaking to tech people who understand the technicalities. If your approach is to avoid implementing this, sure, that’s fine, just be honest about it.
Author
Owner

@liyasthomas commented on GitHub (Nov 21, 2024):

I’d be happy to share updates once the initial candidates for the desktop app are ready for general availability.

Thank you for your patience and understanding throughout this process. We appreciate your continued support.

<!-- gh-comment-id:2491022187 --> @liyasthomas commented on GitHub (Nov 21, 2024): I’d be happy to share updates once the initial candidates for the desktop app are ready for general availability. Thank you for your patience and understanding throughout this process. We appreciate your continued support.
Author
Owner

@oguzydz commented on GitHub (Jan 20, 2025):

Hey, any update?

<!-- gh-comment-id:2601700087 --> @oguzydz commented on GitHub (Jan 20, 2025): Hey, any update?
Author
Owner

@aryaraj132 commented on GitHub (Jan 23, 2025):

Still waiting for this 🙏

<!-- gh-comment-id:2608857729 --> @aryaraj132 commented on GitHub (Jan 23, 2025): Still waiting for this 🙏
Author
Owner

@wapmorgan commented on GitHub (Jan 23, 2025):

One of desktop-app-only features is oauth2.0 without updating callback url in oauth2 provider to hoppscotch instance.
Postman dekstop app can auth without any updates on callback urls list, hoppscotch can not right now

<!-- gh-comment-id:2609084528 --> @wapmorgan commented on GitHub (Jan 23, 2025): One of desktop-app-only features is oauth2.0 without updating callback url in oauth2 provider to hoppscotch instance. Postman dekstop app can auth without any updates on callback urls list, hoppscotch can not right now
Author
Owner

@liyasthomas commented on GitHub (Jan 23, 2025):

We now have an open PR to add the support for self-hosted instances on the desktop app.
Please subscribe to #4684 to receive updates.

<!-- gh-comment-id:2609339351 --> @liyasthomas commented on GitHub (Jan 23, 2025): We now have an open PR to add the support for self-hosted instances on the desktop app. Please subscribe to #4684 to receive updates.
Author
Owner

@cuttingedge1109 commented on GitHub (Mar 1, 2025):

We now have an open PR to add the support for self-hosted instances on the desktop app. Please subscribe to #4684 to receive updates.

I can see this PR has been merged. It means this issue has been fixed?
Is a new version gonna be released soon?

<!-- gh-comment-id:2692079282 --> @cuttingedge1109 commented on GitHub (Mar 1, 2025): > We now have an open PR to add the support for self-hosted instances on the desktop app. Please subscribe to [#4684](https://github.com/hoppscotch/hoppscotch/pull/4684) to receive updates. I can see this PR has been merged. It means this issue has been fixed? Is a new version gonna be released soon?
Author
Owner

@liyasthomas commented on GitHub (Mar 4, 2025):

Thanks for your patience and valuable feedback. We’ve introduced the ability to use self-hosted Hoppscotch instances in the desktop app in the latest release.

Download the latest builds and provide your valuable feedback.

Add your self-hosted Hoppscotch 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”.

Click on the Hoppscotch logo in the top-left corner to switch back and forth between self-hosted instances and cloud instances.

Note

Ensure that your self-hosted instances are updated to the latest version of Hoppscotch.

Important

The self-hosted instance must be publicly accessible from the internet so that users can view its contents within the desktop app.

Closing this ticket as this feature is now available in the recent version. Please feel free to reach out if you have any other concerns.

<!-- gh-comment-id:2697279791 --> @liyasthomas commented on GitHub (Mar 4, 2025): Thanks for your patience and valuable feedback. We’ve introduced the ability to use self-hosted Hoppscotch instances in the desktop app in the latest release. [Download the latest builds](https://hoppscotch.com/download) and provide your valuable feedback. ### Add your self-hosted Hoppscotch 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”. Click on the Hoppscotch logo in the top-left corner to switch back and forth between self-hosted instances and cloud instances. > [!NOTE] > Ensure that your self-hosted instances are updated to the latest version of Hoppscotch. > [!IMPORTANT] > The self-hosted instance must be publicly accessible from the internet so that users can view its contents within the desktop app. Closing this ticket as this feature is now available in the recent version. Please feel free to reach out if you have any other concerns.
Author
Owner

@domints commented on GitHub (Mar 4, 2025):

Is this feature available only for enterprise version or something? I updated my community edition docker images to latest version (2025.2.0), I am pointing desktop app at my instance and it says it cannot reach url /desktop-app-server/api/v1/key. I never saw such url mentioned, it also doesn't seem to be configurable. I also tried checking if maybe my backend responds to /api/v1/key or /v1/key but to no avail - otherwise I'd be fine with hacking my way in using nginx url rewrites.
What do I need to do to make this url available so I can connect desktop app to my BE?

<!-- gh-comment-id:2697443344 --> @domints commented on GitHub (Mar 4, 2025): Is this feature available only for enterprise version or something? I updated my community edition docker images to latest version (`2025.2.0`), I am pointing desktop app at my instance and it says it cannot reach url `/desktop-app-server/api/v1/key`. I never saw such url mentioned, it also doesn't seem to be configurable. I also tried checking if maybe my backend responds to `/api/v1/key` or `/v1/key` but to no avail - otherwise I'd be fine with hacking my way in using nginx url rewrites. What do I need to do to make this url available so I can connect desktop app to my BE?
Author
Owner

@liyasthomas commented on GitHub (Mar 4, 2025):

@domints, pointing to the instance should suffice. I suspect it’s an issue with how the instance has configured subpath-based access.

# Set to `true` for subpath-based access
ENABLE_SUBPATH_BASED_ACCESS=true

If this is set to false, the desktop app cannot access the path directly. In such cases, providing the port should work. For instance, if the instance is running on “localhost,” the instance URL should be “localhost:3200” because that’s where the web app server serves files if subpath access isn’t enabled.

<!-- gh-comment-id:2697487626 --> @liyasthomas commented on GitHub (Mar 4, 2025): @domints, pointing to the instance should suffice. I suspect it’s an issue with how the instance has configured subpath-based access. ``` # Set to `true` for subpath-based access ENABLE_SUBPATH_BASED_ACCESS=true ``` If this is set to false, the desktop app cannot access the path directly. In such cases, providing the port should work. For instance, if the instance is running on “localhost,” the instance URL should be “localhost:3200” because that’s where the web app server serves files if subpath access isn’t enabled.
Author
Owner

@domints commented on GitHub (Mar 4, 2025):

Thanks for the reply!
I just found about that port 3200 from reading the code :) Yeah, my instance is configured in an old way, I think even from before split to community and enterprise :)
So I assume that AIO container has additional service running in it, configured to listen on port 3200 (so I need to add it to my docker-compose). And this additional service still gets its database access etc from .env file just like ordinary backend, so the web and desktop will share the same data set, right?

<!-- gh-comment-id:2697498620 --> @domints commented on GitHub (Mar 4, 2025): Thanks for the reply! I just found about that port 3200 from reading the code :) Yeah, my instance is configured in an old way, I think even from before split to community and enterprise :) So I assume that AIO container has additional service running in it, configured to listen on port 3200 (so I need to add it to my docker-compose). And this additional service still gets its database access etc from .env file just like ordinary backend, so the web and desktop will share the same data set, right?
Author
Owner

@LordSimal commented on GitHub (Mar 4, 2025):

A question about this new service. We have a reverse proxy setup for all those services so one can access them easily via HTTPS, therefore

  • api-docs.mydomain.com => Port 3000
  • api-docs-admin.mydomain.com => Port 3100
  • api-docs-backend.mydomain.com => Port 3170

and now

  • api-docs-app.mydomain.com => Port 3200

Therefore I am now able to login via the desktop app to my service via api-docs-app.mydomain.com but still something is wrong. E.g. it doesn't load additional workspaces, I only see (there should be 1 more workspace present)

Image

also if I add a test request to my personal workspace in the app it doesn't show up in the webinterface.

Should I create a separate issue for this?

<!-- gh-comment-id:2697554916 --> @LordSimal commented on GitHub (Mar 4, 2025): A question about this new service. We have a reverse proxy setup for all those services so one can access them easily via HTTPS, therefore - api-docs.mydomain.com => Port 3000 - api-docs-admin.mydomain.com => Port 3100 - api-docs-backend.mydomain.com => Port 3170 and now - api-docs-app.mydomain.com => Port 3200 Therefore I am now able to login via the desktop app to my service via `api-docs-app.mydomain.com` but still something is wrong. E.g. it doesn't load additional workspaces, I only see (there should be 1 more workspace present) ![Image](https://github.com/user-attachments/assets/1fabe58c-4b62-4466-b40e-eec184284218) also if I add a test request to my personal workspace in the app it doesn't show up in the webinterface. Should I create a separate issue for this?
Author
Owner

@liyasthomas commented on GitHub (Mar 4, 2025):

Please create a discussion thread if you think it's appropriate or alternatively create an issue ticket if it's a bug report or feature request.

<!-- gh-comment-id:2697571149 --> @liyasthomas commented on GitHub (Mar 4, 2025): Please create a [discussion](https://github.com/hoppscotch/hoppscotch/discussions/new/choose) thread if you think it's appropriate or alternatively create an [issue](https://github.com/hoppscotch/hoppscotch/issues/new/choose) ticket if it's a bug report or feature request.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/hoppscotch#1195
No description provided.