added janusagent documentation

This commit is contained in:
gezimblliku
2024-07-30 16:29:12 +02:00
committed by Dan Christian Bogos
parent 22b96ca1e3
commit 59b61f2354
3 changed files with 42 additions and 2 deletions

View File

@@ -51,7 +51,7 @@
"attributes_conns": ["*localhost"], "attributes_conns": ["*localhost"],
"cdrs_conns": ["*localhost"], "cdrs_conns": ["*localhost"],
"rals_conns": ["*localhost"], "rals_conns": ["*localhost"],
"chargers_conns": ["*internal"], "chargers_conns": ["*internal"],
"channel_sync_interval": "15s" "channel_sync_interval": "15s"
}, },

View File

@@ -19,4 +19,5 @@ Following *Agents* are implemented within CGRateS:
astagent astagent
fsagent fsagent
kamagent kamagent
ers ers
janusagent

39
docs/janusagent.rst Normal file
View File

@@ -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 <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: <true|false>
"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 <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 <https://github.com/meetecho/janus-gateway?tab=readme-ov-file#dependencies/>`_.