From 59b61f235445d0a376ec8d4f76ada24bebd67dfe Mon Sep 17 00:00:00 2001 From: gezimblliku Date: Tue, 30 Jul 2024 16:29:12 +0200 Subject: [PATCH] added janusagent documentation --- data/conf/samples/janus_agent/cgrates.json | 2 +- docs/agents.rst | 3 +- docs/janusagent.rst | 39 ++++++++++++++++++++++ 3 files changed, 42 insertions(+), 2 deletions(-) create mode 100644 docs/janusagent.rst diff --git a/data/conf/samples/janus_agent/cgrates.json b/data/conf/samples/janus_agent/cgrates.json index e549a1786..b956aa9b3 100644 --- a/data/conf/samples/janus_agent/cgrates.json +++ b/data/conf/samples/janus_agent/cgrates.json @@ -51,7 +51,7 @@ "attributes_conns": ["*localhost"], "cdrs_conns": ["*localhost"], "rals_conns": ["*localhost"], - "chargers_conns": ["*internal"], + "chargers_conns": ["*internal"], "channel_sync_interval": "15s" }, diff --git a/docs/agents.rst b/docs/agents.rst index e474abebb..4413abac2 100644 --- a/docs/agents.rst +++ b/docs/agents.rst @@ -19,4 +19,5 @@ Following *Agents* are implemented within CGRateS: astagent fsagent kamagent - ers \ No newline at end of file + ers + janusagent \ No newline at end of file diff --git a/docs/janusagent.rst b/docs/janusagent.rst new file mode 100644 index 000000000..61cd95579 --- /dev/null +++ b/docs/janusagent.rst @@ -0,0 +1,39 @@ +.. _JanusAgent: + +JanusAgent +============= + + +**JanusAgent** is an api endpoint that connects to JanusServer through **CGRateS**. +It authorizes webrtc events in **CGRateS** for each user and after managing and creating sessions in JanusServer. + +The **JanusAgent** is configured within *janus_agent* section from :ref:`JSON configuration `. +It will listen on http port 2080 in /janus endpoint as specified in config ,it will accept same http requests that would be sent normally to JanusServer. + +Sample config + +:: + + "janus_agent": { + "enabled": false, // enables the Janus agent: + "url": "/janus", + "sessions_conns": ["*internal"], + "janus_conns": [{ // instantiate connections to multiple Janus Servers + "address": "127.0.0.1:8088", // janus API address + "type": "*ws", // type of the transport to interact via janus API + "admin_address": "localhost:7188", // janus admin address used to retrive more information for sessions and handles + "admin_password": "", // secret to pass restriction to communicate to the endpoint + }], + "request_processors": [], // request processors to be applied to Janus messages +}, + +Config params +^^^^^^^^^^^^^ + +Most of the parameters are explained in :ref:`JSON configuration `, hence we mention here only the ones where additional info is necessary or there will be particular implementation for *JanusAgent*. + +Software Installation +--------------------- + + For detailed information on installing JanusServer on Debian, please refer to its official `repository `_. +