conference-server
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:
Name | Description | Default Value | Default Unit | Type |
---|---|---|---|---|
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: | 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: | 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. | StringList | ||
database-backend | Choose the type of database backend that the conference server will use persistency of chatrooms and conferences data. | mysql | String | |
database-connection-string | The configuration parameters of the database backend used for persistency of chatrooms and conference data. | 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. | 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: | text | StringList | |
encryption | The media encryption the conference server will offer when calling participants to an audio or video conference . | 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: | StringList | ||
empty-chat-room-deletion | Whether the conference server will delete chat rooms that have no participants registered. | true | Boolean | |
call-timeout | Call timeout. | 0 | second | DurationS |