Skip to content

Add websocket paths to the selfhosted guide #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lixmal merged 1 commit into from
Oct 2, 2025
Merged

Add websocket paths to the selfhosted guide #439

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/pages/selfhosted/selfhosted-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,19 @@ Endpoint | Protocol | Target service and internal-port
------------------------------- | --------- | --------------------------------
/ | HTTP | dashboard:80
/signalexchange.SignalExchange/ | gRPC | signal:80
/ws-proxy/signal | WebSocket | signal:80
/api | HTTP | management:443
/management.ManagementService/ | gRPC | management:443
/ws-proxy/management | WebSocket | management:443
/relay | WebSocket | relay:33080
:33080 (UDP) | QUIC | relay:33080 (direct or L4 proxy)

Make sure your reverse-Proxy is setup to use the HTTP2-Protocol when forwarding.

<Note>
The relay service supports two transport options: WebSocket (via `/relay`) or QUIC over UDP on port 33080 (not HTTP/3). You only need to configure one - either the WebSocket endpoint through your reverse proxy, or direct UDP access for QUIC. QUIC cannot be proxied through typical HTTP reverse proxies and must either be exposed directly or proxied using an L4 (transport layer) proxy that supports UDP. Some reverse proxies may support QUIC proxying, but this typically requires specific configuration for the custom application protocol.
</Note>

<Note>
You can find helpful templates with the reverse-proxy-name as suffix (e.g. `docker-compose.yml.tmpl.traefik`)
Simply replace the file `docker-compose.yml.tmpl` with the chosen version.
Expand Down