conference-server

Last modified by Buildbot on 2024/04/20 01:13

 Documentation based on repostory git version commit 2.4.0-alpha-160-g97b70675 

Conference server

Flexisip conference server parameters.
The Flexisip conference server is in charge of groupchat and audio/video conferences.It follows the concepts of RFC4579 for conference establishment and management, and as such factory and focus URIs must be configured.
It requires a MariaDB/MySQL database in order to persistently store chatroom or conference state (participants and their devices). For chat, it requires the Registrar backend (see section module::Registrar) to discover devices (or client instances) of each participant, which creates an explicit dependency on Flexisip proxy server.
This dependency is not required for audio/video conferences.
----

Configuration options:

NameDescriptionDefault ValueDefault UnitType
enabled

Enable conference server

 true Boolean
transport

URI where the conference server must listen. Only one URI can be specified.

 sip:127.0.0.1:6064;transport=tcp String
conference-factory-uris

List of SIP URIs used by clients to create a conference. This implicitely defines the list of SIP domains managed by the conference server. For example:
conference-factory-uris=sip:conference-factory@sip.linphone.org sip:conference-factory@sip.linhome.org

  StringList
conference-focus-uris

List of respective template SIP focus URIs to use for conferences created by the factory URIs given in 'conference-factory-uris'. The focus URIs are unique SIP URIs targeting a specific conference. A 'conf-id' URI parameter providing uniqueness is automatically appended at runtime. For example, setting:
conference-focus-uris=sip:conference-focus@sip.linphone.org
causes the conference server to generate conference URIs in the form of 'sip:conference-focus@sip.linphone.org;conf-id=<something random>' when requested to create a conference.

  StringList
outbound-proxy

The SIP proxy URI to which the conference server should sent all its outgoing SIP requests.

 sip:127.0.0.1:5060;transport=tcp String
local-domains

Domains managed by the local SIP service, ie domains for which user registration information can be found directly from the local registrar database (redis database). For external domains (not in this list), a 'reg' SUBSCRIBE (RFC3680) will be emitted.It is not necessary to list here domains that appear in the 'conference-factory-uris' property. They are assumed to be local domains already.
Ex: local-domains=sip.linphone.org conf.linphone.org linhome.org

  StringList
database-backend

Choose the type of database backend that the conference server will use persistency of chatrooms and conferences data.
Provided that the requested Soci modules are installed, the supported database backends are: `mysql`, `sqlite3`

 mysql String
database-connection-string

The configuration parameters of the database backend used for persistency of chatrooms and conference data.
The basic format is "key=value key2=value2". For a MySQL backend, this is a valid config: "db=mydb user=user password='pass' host=myhost.com".
Please refer to the Soci documentation of your backend, for instance: http://soci.sourceforge.net/doc/3.2/backends/mysql.htmlhttp://soci.sourceforge.net/doc/3.2/backends/sqlite3.html

 db='mydb' user='myuser' password='mypass' host='myhost.com' String
check-capabilities

Whether the conference server shall check device capabilities before inviting them to a session.
The capability check is currently limited to Linphone client that put a +org.linphone.specs contact parameter in order to indicate whether they support group chat and secured group chat.

 true Boolean
supported-media-types

List of media supported by the conference server. This typically allows to specify whether this conference server instance is able to provide chat service or audio/video conference service, or both.Valid values are: audio, video and text. For example:
supported-media-types=audio video text

 text StringList
encryption

The media encryption the conference server will offer when calling participants to an audio or video conference .
Valid values are: none, sdes, zrtp and dtls.

 none String
nat-addresses

Public host name or IP addresses of the conference server machine. Configuring this property is required when the conference server is deployed behind a firewall, so that the public IP address (v4, v6) can be advertised in SDP, as ICE server-reflexive candidates in order for the conference server to receive RTP media packets from clients. If no hostname is given, the v4 and v6 IP address can be listed separated by whitespaces, in any order. It is not possible  to configure several v4 addresses or several v6 addresses.For example:
nat-addresses=conference.linphone.org
nat-addresses=5.135.31.160   2001:41d0:303:3aee::1

  StringList
empty-chat-room-deletion

Whether the conference server will delete chat rooms that have no participants registered.

 true Boolean
call-timeout

Call timeout.
This settings allows the conference server to kill all incoming calls that last longer than the call-timeout setting.
A value of 0 prevents the conference server to kill any call due to this timeout

 0 secondDurationS