diff options
Diffstat (limited to 'docs/WEBSOCKET.md')
| -rw-r--r-- | docs/WEBSOCKET.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/WEBSOCKET.md b/docs/WEBSOCKET.md new file mode 100644 index 0000000..7a19b03 --- /dev/null +++ b/docs/WEBSOCKET.md @@ -0,0 +1,27 @@ +# WebSocket · HyBBX 2.8.0 + +WebSocket forward-proxy for browser and rich clients — core stays text-first. + +## Transport matrix + +| Item | Value | +|------|-------| +| Plugin | `HYBBX_PLUGIN_WEBSOCKET=ON` (default) | +| Default port | `4591` (plain); wss with OpenSSL | +| INI | `[networks] websocket=yes`, `[transport.websocket]` | +| Reverse proxy | nginx/caddy TLS termination typical | + +## Security matrix + +| Item | Value | +|------|-------| +| User auth | Same as telnet — session login | +| TLS | Optional `-DHYBBX_CRYPTO_OPENSSL=ON` for wss | +| Link auth | Separate from HBX circuit auth | + +## Related + +| Goal | Doc | +|------|-----| +| Clients | [CLIENTS.md](CLIENTS.md) | +| Security | [SECURITY.md](SECURITY.md) | |