4nk/sdk_relay
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
sdk_relay/docs/USAGE.md
Nicolas Cantu ccdb2d69fb
Some checks failed
CI - sdk_relay / build-test (push) Failing after 37s
Details
CI - sdk_relay / security (push) Successful in 2m3s
Details
docs(sdk_relay): alignement avec 4NK_node (installation, usage, configuration, testing, quick ref, dev, performance, troubleshooting, open source, gitea, release, roadmap, security audit)
2025-08-25 15:31:34 +02:00

610 B
Raw Blame History

Utilisation - sdk_relay

Démarrage rapide

  • Démarrer le service (Docker ou binaire)
  • Vérifier GET /health
  • Connecter un client WebSocket à ws://host:8090

WebSocket

  • Envoyer un handshake JSON avec type=handshake
  • Recevoir handshake_response
  • S'abonner aux notifications si nécessaire (subscribe)

HTTP

  • GET /health : santé
  • GET /metrics : métriques
  • GET /relays : relais connus
  • POST /sync/force : forcer une synchronisation

Bonnes pratiques

  • Reconnexion automatique côté client
  • Heartbeat régulier (ping/pong)
  • Limiter la taille des messages (< 1MB)