Add WebSocket configuration documentation
All checks were successful
build-and-push-ext / build_push (push) Successful in 8s

- Document environment variables (WS_BIND_URL, HEALTH_PORT, HEALTH_BIND_ADDRESS)
- Document WebSocket headers requirements
- Document expected responses and error handling
This commit is contained in:
4NK Dev 2025-09-20 21:50:25 +00:00
parent 73191c4a6b
commit f318140d59

View File

@ -0,0 +1,28 @@
# Configuration WebSocket - SDK Relay
## Variables d'environnement
- `WS_BIND_URL` : URL de binding WebSocket (défaut: `0.0.0.0:8090`)
- `HEALTH_PORT` : Port du serveur de santé (défaut: `8091`)
- `HEALTH_BIND_ADDRESS` : Adresse de binding du serveur de santé (défaut: `0.0.0.0`)
## Configuration WebSocket
Le relay accepte uniquement les connexions WebSocket valides avec les headers :
- `Upgrade: websocket`
- `Connection: upgrade`
- `Sec-WebSocket-Version: 13`
- `Sec-WebSocket-Key: [base64-encoded-key]`
## Réponse attendue
```
HTTP/1.1 101 Switching Protocols
connection: Upgrade
upgrade: websocket
sec-websocket-accept: [calculated-accept-key]
```
## Rejet des requêtes HTTP
Les requêtes HTTP simples sont rejetées avec l'erreur :
`WebSocket protocol error: Unsupported HTTP method used - only GET is allowed`
## Date
2025-09-20