Rustdesk for iOS and Websockets?

[dumblestrike]

We are a self-hosted Pro site. We are using websockets to connect our custom app/client builds... They are working fine with a websocket override. However, we are having an issue with the iOS app. Can the iOS app be configured to use websockets?

Ensure WebSocket support is enabled in server config
• In RustDesk Server Pro, make sure allow-websocket=Y in your Custom Client / Advanced Settings.
• Confirm the reverse proxy / server is configured to accept WebSocket connections on the ID /ws/id and relay /ws/relay endpoints, with proper SSL/WSS support.
2. Make sure the iOS client is updated (version 1.5.1 or newer) and see if there’s a setting to enable WebSocket. Sometimes mobile apps need explicit toggles or get updated to include support after server-side features have already been introduced. The App Store version mentioned enabling WebSocket support in settings.
3. Custom Client Build (if needed)
• If the official iOS app does not expose WebSocket support via settings or server override, you might need to build a custom version of the iOS client with WebSocket enabled.
• Then distribute that to your users (provisioning / enterprise distribution etc.). Using custom client, you can bind allow-websocket=Y in the custom client profile to force WebSocket behavior.
4. Testing & fallback
• Once configured, test the connection (with some network that blocks the usual RustDesk ports but allows WebSocket via 443) to verify the iOS client is using WebSocket.
• Check logs / debug output (client logs) to see whether it’s connecting via /ws/id and /ws/relay or still via fallback methods.
• If connection fails over WebSocket, look for errors like certificate mismatch, Reverse Proxy configuration (Upgrade header, timeouts), or port forwarding.

let’s tackle this systematically so you can rule out every possible blocker for getting the iOS app to use WebSockets with your RustDesk Pro server.

1. Enable WebSocket in Pro / Custom Client
   • In your Pro server “Custom Client → Advanced Settings” set:

allow-websocket=Y

⚠️ Important:
• WebSocket is only supported for relay (not ID server).
• This flag tells clients they may use WS, but the client app must also support it.

2. Expose WSS endpoints with reverse proxy

RustDesk expects:
• /ws/id → forwarded to your ID server WebSocket port (default: 21118)
• /ws/relay → forwarded to your Relay server WebSocket port (default: 21119)

✅ Example nginx config:

server {
listen 443 ssl http2;
server_name rustdesk.example.com;

ssl_certificate /etc/letsencrypt/live/rustdesk.example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/rustdesk.example.com/privkey.pem;

location /ws/id {
    proxy_pass http://127.0.0.1:21118;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "Upgrade";
    proxy_read_timeout 86400;
}

location /ws/relay {
    proxy_pass http://127.0.0.1:21119;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "Upgrade";
    proxy_read_timeout 86400;
}

}

Make sure your firewall allows 21118/21119 if you don’t proxy them.

3. Confirm iOS App version & toggle
   • Update to RustDesk iOS v1.5.1+ from App Store.
   • In the iOS app settings, there should be a “Enable WebSocket” toggle.
   • Turn it on.

4. Verify WebSocket usage in logs

On the server:

Check nginx logs:

tail -f /var/log/nginx/access.log

Look for:

GET /ws/relay HTTP/1.1" 101 Switching Protocols
GET /ws/id HTTP/1.1" 101 Switching Protocols

The 101 code confirms a WebSocket upgrade.

On the client:

Enable debug logs in the iOS app → look for connection attempts to /ws/id or /ws/relay.

5. Common failure points
   • ❌ Certificates: must be valid; self-signed will fail unless trusted manually.
   • ❌ Proxy headers: missing Upgrade / Connection: Upgrade will break WS.
   • ❌ Timeouts: make sure proxy_read_timeout is long (e.g., 86400).
   • ❌ Firewall: open 21118/21119 if you’re not using a proxy.
   • ❌ Fallback: If WS fails, iOS silently falls back to TCP/UDP → looks like “not working.”

6. Custom iOS Client (last resort)

If the App Store build won’t honor WebSocket:
• Build a custom iOS client from the RustDesk source with allow-websocket=Y baked in.
• Sign/distribute via Apple Enterprise Program or TestFlight.
• This guarantees WebSocket use since the toggle is enforced.