From f318140d5952879fc10d25d8e3e7aff816fb3ffd Mon Sep 17 00:00:00 2001 From: 4NK Dev Date: Sat, 20 Sep 2025 21:50:25 +0000 Subject: [PATCH] Add WebSocket configuration documentation - Document environment variables (WS_BIND_URL, HEALTH_PORT, HEALTH_BIND_ADDRESS) - Document WebSocket headers requirements - Document expected responses and error handling --- docs/WEBSOCKET_CONFIGURATION.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/WEBSOCKET_CONFIGURATION.md diff --git a/docs/WEBSOCKET_CONFIGURATION.md b/docs/WEBSOCKET_CONFIGURATION.md new file mode 100644 index 0000000..c4d7d43 --- /dev/null +++ b/docs/WEBSOCKET_CONFIGURATION.md @@ -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