Skip to content

feat: use /ws/id and /ws/relay as default WebSocket paths - #24

Merged
rophy merged 2 commits into
masterfrom
feat/ws-default-paths
Aug 24, 2026
Merged

feat: use /ws/id and /ws/relay as default WebSocket paths#24
rophy merged 2 commits into
masterfrom
feat/ws-default-paths

Conversation

@rophy

@rophy rophy commented Aug 24, 2026

Copy link
Copy Markdown
Owner

User description

Summary

  • Change web client default WebSocket paths from /hbbs+/hbbr to /ws/id+/ws/relay, matching the standard paths used by RustDesk Pro and native clients
  • Update tests and README to reflect the new defaults
  • Fix .gitignore to anchor rustdesk pattern to repo root

Details

The previous /hbbs and /hbbr paths were custom and required rewrite rules in the reverse proxy. The standard /ws/id and /ws/relay paths are what hbbs/hbbr natively serve, so no rewrite is needed — simplifying proxy configuration.

Runtime config via config.json / RUSTDESK_HOST / RUSTDESK_RELAY env vars still works and overrides these defaults.

Test plan

  • All 16 url.test.ts tests pass
  • Verified end-to-end: web client connects to native peer via /ws/id and /ws/relay through Istio VirtualService

PR Type

Enhancement, Tests, Documentation


Description

  • Change default WebSocket paths to standard endpoints

  • Align web client with native RustDesk clients

  • Update URL resolution unit tests accordingly

  • Revise README documentation and Nginx proxy examples


Diagram Walkthrough

flowchart LR
  webClient["Web Client"] -- "Default HOST" --> wsId["/ws/id"]
  webClient -- "Default RELAY" --> wsRelay["/ws/relay"]
  wsId -- "Proxies to" --> hbbs["hbbs:21118"]
  wsRelay -- "Proxies to" --> hbbr["hbbr:21119"]
Loading

File Walkthrough

Relevant files
Tests
url.test.ts
Update WebSocket paths in URL resolution unit tests           

flutter/web/js/src/url.test.ts

  • Replace /hbbs with /ws/id across all test cases
  • Replace /hbbr with /ws/relay across all test cases
+23/-23 
Configuration changes
url.ts
Change default WebSocket host and relay paths                       

flutter/web/js/src/url.ts

  • Update HOST default value to /ws/id
  • Update RELAY_HOST default value to /ws/relay
+2/-2     
Documentation
README.md
Update README with new default WebSocket paths                     

docker/web-client/README.md

  • Update default path references in the documentation text
  • Modify environment variable examples to use the new paths
  • Update the Nginx reverse proxy configuration examples
+9/-9     

rophy added 2 commits August 23, 2026 22:58
Bare `rustdesk` pattern was matching deploy/helm/rustdesk/ directory.
Also exclude helm values override files containing private config.
Match the standard paths that RustDesk Pro and native clients use,
instead of custom /hbbs and /hbbr paths that required rewrite rules.
@coderabbitai

coderabbitai Bot commented Aug 24, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 11cba1c8-2f3c-4ba4-b05f-4a5d93fa1c96

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@npe-pr-agent

npe-pr-agent Bot commented Aug 24, 2026

Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 PR contains tests
🔒 No security concerns identified
⚡ No major issues detected

@npe-pr-agent

npe-pr-agent Bot commented Aug 24, 2026

Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@rophy
rophy merged commit 270ad77 into master Aug 24, 2026
28 checks passed
@rophy
rophy deleted the feat/ws-default-paths branch August 24, 2026 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant