sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-15 23:16:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add websocket paths (#439)

Browse Source
This commit is contained in:
Viktor Liu
2025-10-02 13:49:06 +02:00
committed by GitHub
parent ff9b7b7b58
commit ddc690886a
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/pages/selfhosted/selfhosted-guide.mdx
View File

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