From f2ef566acc973f415ddebc7800adf7bdab87004c Mon Sep 17 00:00:00 2001 From: Joachim Bauch Date: Wed, 29 Oct 2025 15:00:54 +0100 Subject: [PATCH] Add note on how to configure Janus events. --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 48df0c9..2c23600 100644 --- a/README.md +++ b/README.md @@ -139,14 +139,23 @@ server. A Janus server (from https://github.com/meetecho/janus-gateway) can be used to act as a WebRTC gateway. See the documentation of Janus on how to configure and -run the server. At least the `VideoRoom` plugin and the websocket transport of -Janus must be enabled. +run the server. At least the `VideoRoom` plugin, the websocket transport and the +websocket events handler of Janus must be enabled. Also broadcasting of events +must be enabled. The signaling server uses the `VideoRoom` plugin of Janus to manage sessions. All gateway details are hidden from the clients, all messages are sent through the signaling server. Only WebRTC media is exchanged directly between the gateway and the clients. +To enable sending of events from Janus, the option `broadcast` must be set to +`true` in the block `events` of `janus.jcfg`. In the configuration of the +websocket events handler (`janus.eventhandler.wsevh.jcfg`), the module must be +enabled by setting `enabled` to `true`, the `backend` must be set to the +websocket url of the signaling server (or signaling proxy) and `subprotocol` +must be set to `janus-events`. +At least events of type `media` must be subscribed. + Edit the `server.conf` and enter the URL to the websocket endpoint of Janus in the section `[mcu]` and key `url`. During startup, the signaling server will connect to Janus and log information of the gateway.