← Back to PRs

#21233: docs: clarify bind=lan non-loopback access requires wss or tunnel (#21158)

by saurabhchopade open 2026-02-19 20:18 View on GitHub →
docs gateway size: XS
## Summary Refs #21158. Add documentation guidance for the `bind=lan` / non-loopback case where direct plaintext WebSocket URLs are rejected by security checks. ## Changes `docs/cli/gateway.md`: clarified that direct non-loopback targets should use `wss://` (or SSH tunnel to loopback), and that plain `ws://<non-loopback>` is blocked. - `docs/gateway/troubleshooting.md`: added explicit troubleshooting notes/signatures for: - plaintext non-loopback `ws://` rejection - when to enable `gateway.tls.enabled=true` - using loopback/SSH tunnel for local operator checks Refs #21158. <!-- greptile_comment --> <h3>Greptile Summary</h3> Adds documentation clarifying that direct non-loopback WebSocket connections must use `wss://` or SSH tunneling, aligning with the security checks in `src/gateway/net.ts:isSecureWebSocketUrl()` that block plaintext `ws://` to non-loopback addresses (line 429-430). The changes accurately describe the error signature users see when the security check fails and provide correct remediation guidance. <h3>Confidence Score: 5/5</h3> - This PR is safe to merge with no risk - Documentation-only changes that accurately describe existing security behavior. The guidance correctly references `gateway.tls.enabled=true` (verified in `src/config/types.gateway.ts:3-13`), matches the actual error message from `src/gateway/call.ts:161`, and provides valid workarounds (wss:// or SSH tunnel) that align with the security check implementation in `src/gateway/net.ts:413-431` - No files require special attention <sub>Last reviewed commit: 4fbac9a</sub> <!-- greptile_other_comments_section --> <!-- /greptile_comment -->

Most Similar PRs