summaryrefslogtreecommitdiff
path: root/docs/WEBSOCKET.md
blob: 7a19b03be533bfb3ee37c082a4150cad03b11887 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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) |
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com