# TrueConf Server administration

# Control panel

# Summary

In the summary section you can view your license information and contact person, check available extensions, re-register TrueConf Server, or purchase new licenses:

/server/media/information/en.png

In case of any problems with TrueConf Server registration, the administrator may reach out to TrueConf technical support team via the contacts that will be displayed in case of an error.

Warning!

If you're using a free version of TrueConf Server and connection to our registration server (host is reg.trueconf.com and TCP port is 4310) is lost, your server will shut down in 12 hours. The expected shut down time will be displayed in the Summary tab. The full version of TrueConf Server does not impose such limitations.

If the server is connected to the Internet, administrator will be able to receive notifications updates in TrueConf Server control panel. In the left menu of the control panel you will see a notification, while at the top of the page a message with the latest version download link will be displayed. After you have updates, the notification will disappear.

# Settings

In this section you can specify the work path for TrueConf Server data, view server reports and statistics and configure client applications.

/server/media/settings/en.png
  1. A path to a working directory of server.

  2. Enable extensive logging of server activities. Might be required by our technical support team for troubleshooting.

  3. Create a backup file with server settings.

  4. Restore your settings using a backup file.

  5. Download links for client applciations, which are published for your users on the guest page.

  6. A field for generating a secret key. It is used for creating session keys to authenticate users in a video conference. To replace your key with a new one, press Generate a new key button. By replacing the key you can make your conference more secure (e.g. inhibit third-party connections).

  7. A key similar to the previous one. It controls authorizing using guest accounts in public conferences.

  8. Hard limit the output bitrate from client applications to TrueConf Server and other endpoints (in kbps).

  9. Set maximum FPS rate transmitted from TrueConf Server to a client.

  10. Set frame size limits in pixels.

  11. Enable statuses, polls or reactions during a conference.

  12. Save application settings.

Warning!

We strongly advise you not to use settings 6-10, unless being told so by our technical support team, as they might significantly decrease the quality of your video conferences or put TrueConf Server security at risk. The ability of TrueConf Server to automatically and dynamically manage video streams encoding parameters is crucial for effective collaboration.

# Configuration back-up and restore

Backup allows you to export and save most of the server settings excluding HTTPS settings, log files and usage reports. Backup file is essential for TrueConf Server migration and re-installation tasks. You can find the full guide on making a backup copy of and restoring the settings after a server transfer in our knowledge base.

# Applications update settings

Below you can see the client application section. Here you can put limitations on the versions of the applications which will be used for video calls and conferences on your TrueConf Server instance. Click on the client application in the first table row to open the settings window:

/server/media/nastroyki_tcc/en.png
  1. Minimal version of the client application supported by TrueConf Server. If the current version of client application is lower that the one specified here, client application will be stopped and mandatory updated.

  2. Preferred version of the client application. If the version of the app is older than the version specified in this field, the user will be prompted to update. It's possible to cancel the update and continue to use the application unless it's version is higher then the Minimal one.

  3. The version of client application which will be offered for update.

# Network

This section covers TrueConf Server settings for connectivity with other TrueConf Server instances, client applications, third-party SIP or H.323 endpoints and email templates for notifications.

# Network settings

In this section you can specify IP addresses and ports which will be used by TrueConf client applications to connect to TrueConf Server. IP address of the computer where TrueConf Server is installed is used by default.

Tip

Client applications communicate with TrueConf Server over 4307 TCP port. It is the only port that is used for signalling, authentification and audio and video streams. During slide show, file sharing and API calls, HTTP and HTTPS ports specified in the External addresses section are also used.

Neither UDP nor any other TCP port can be used for communication between TrueConf Server and client applications.

The list of Internal addresses includes those addresses and ports that TrueConf Server listens for incoming connections from the client applications. These are the addresses of network interfaces available from the computer where TrueConf Server is installed. When Listen on all IP addresses box is checked (it is usually checked by default), the list is automatically compiled with all such addresses. If you want to edit the list as you see fit, please uncheck this box.

Client applications downloaded from TrueConf Server will try to connect to the addresses from the External addresses on a first-priority basis (if they are unavailable, they will try to connect to internal addresses). This list may include the addresses forwarding to the internal addresses, IP address of your NAT, DNS name or the addresses where you are planning to move TrueConf Server to (this is usually done so that the applications that were downloaded previously could connect to the server via a new IP address). If the server is designed to operate on LAN only, you don't need to use this list.

Tip

This guide does not cover TCP port forwarding or DNS names. You can learn more about these topics in your network equipment manuals.

If you plan to migrate the server to another IP address, all you need to do is to add the new IP address to the list of external address beforehand. This will help client apps to store the new address right after the next connection to the server in advance.

/server/media/nastroyki_seti/en.png
  1. This box is checked by default. Please uncheck it if you want to change internal addresses.

  2. To specify an external addresses by Add button, enable this checkbox.

  3. To add a new internal or external IP address.

  4. Return to previous settings.

  5. Click to save the changes.

# SMTP

TrueConf Server doesn't have a built-in mail server and relies on external SMTP server or service to deliver email notifications, invitations and other important messages to your users. You can change the templates used for these messages in this section as well.

In case of a missed call TrueConf Server will try to locate user's email address from E-mail field in Account information or corresponding field imported during LDAP synchronization.

If you are scheduling a meeting from the control panel, all invited participants will receive notifications containing meeting date and time (if specified). If invited participants are offline (unavailable or unauthorized) when the meeting starts, they will receive a notification about a missed call.

/server/media/smtp/en.png
  1. IP address or SMTP server host name.

  2. Port used by SMTP server.

  3. Select connection security method (STARTTLS, SSL or without encoding).

  4. Select authorization type (with or without password).

  5. If you have selected password authorization please specify a username used on the remote SMTP server for connections from TrueConf Server.

  6. All emails will be delivered using this SMTP From field address (if specified).

  7. Shows SMTP server connection status successfully connected in case of successful connection and authorization on external SMTP server and invalid server if the connection can not be established.

  8. Update connection status.

  9. Email address of TrueConf Server administrator. Enable the checkbox below if you'd like to receive notifications about unexpected TrueConf Server restart events.

  10. Enables email notifications about missed calls.

  11. Restore all email templates to defaults.

  12. Template of a missed call email send to registered users.

  13. Template of a missed call email send to unregistered users, e.g. if someone will try to call an email address from TrueConf client applications, the owner of this address will receive an invitation to register on this server.

  14. Enables notifications about the meetings scheduled on the server (based on the date and time specified in the meeting settings).

  15. Template of the invitation email.

  16. Click to save changes.

# Parameters used in email templates

Use the following syntactic structures to customize the templates of emails sent by TrueConf:

  • For notifying users about missed calls:

    • %caller_display_name — display name of the caller

    • %сaller_call_id — ID of the user who made the call (e.g. user@server.trueconf.name)

    • %recipient_display_name — display name of the caller (the user who missed the call)

    • %missed_call_time — time and date of the call.

  • For inviting to a conference:

    • %conf_name — name of the conference

    • %conf_id — ID of the conference, e.g. \c\df0a2adebe

    • %owner_name — display name of the conference owner

    • %user_display_name — display name of the user who invited to the conference

    • %start_time — time and date of the conference. Time is provided for UTC+00:00 time zone, be aware of your time zone difference

    • %hostTrueConf Server external web address

    • http[s]://%host/c/%conf_id — link to join the conference from PC, macOS devices, mobiles, SIP/H.323 endpoints and browsers, eg. https://server.trueconf.name/c/CID.

Server administrator contacts parameters:

  • %admin_name — display name

  • %admin_email — email address

  • %admin_phone — phone number.

# Federation

Federation allows TrueConf Server users to call and invite to conferences remote users of other TrueConf Server instances. Federation is available only in full version of TrueConf Server (e.g. - for every paid license). The number of servers involved in federation is unlimited. Group video conferences will be conducted with regard to the license limitations of the server initiating the connection.

TrueConf Server instances can be federated if the connection between them is available. Server connection availability may be defined by black list (in this case the federation is available for all the servers that are not blacklisted) or white list (in this case the federation is available only for those servers that are whitelisted).

For example, by adding trueconf.com to the whitelist, you can allow your server users to call and receive calls from TrueConf Online cloud video conferencing service users (only those whose TrueConf ID has the following format: id@trueconf.com). By blacklisting videoserver.company.com, you will prohibit calls between your server users and any users whose ID has the following format: id@videoserver.company.com.

Tip

The server should be available to other servers by its FQDN name indicated during the registration process. The server can be registered both under an existing DNS name or a real server address using SRV DNS records. You can learn more about this topic in client application automatic settings section.

/server/media/federation/en.png
  1. Allow connections from all servers except blacklisted ones.

  2. Federation is disabled.

  3. Allow connections with whitelisted servers only.

  4. Click to add a remote server to the blacklist.

  5. Click to add a remote server to the whitelist.

  6. Click to save changes.

# Gateways

# SIP gateway

TrueConf Server has built-in gateway for SIP, H.323, and RTSP protocols interoperability. This section helps to configure TrueConf Server built-in SIP gateway parameters. The number of rules created using these settings is unlimited.

Tip

Built-in gateway is necessary only if you need to call the devices connected to a third-party server (e.g. H.323 gatekeeper, PBX, MCU). Otherwise you can use the call string for SIP/H.323 devices.

Note

TrueConf Server Free version provides only one active connection through the gateway, including SIP, H.323 and RTSP protocols.

Calling up devices via SIP gateway requires specific call string formats.

/server/media/sip/en.png

# Network settings

This list contains the addresses that are used by the gateway to listen for incoming SIP connections. By default the list is prefilled with IP addresses provided by your operating system. You can edit this list by unchecking Listen on all IP addresses checkbox.

# Rules for SIP connections

In this section you can create specific rules for certain SIP addresses or call directions. For example, you can use special set of settings to connect to Skype for Bussiness servers and another one for PBX connectivity. Every rule is relevant only for target address specified in Host field. Every rule redefines global settings for SIP connections.

Gateway can also authenticate on and maintain active connection with SIP devices for which the rules have been created. This option can be useful to maintain permanent connection with PBX or VoIP services. You can find the connection status in the rules for SIP Connections table.

To create a new rule, click Add configuration and select one of the two possible templates: manual configuration or Skype for Bussiness connection. Skype for Bussiness template has some preselected features required for Skype for Bussiness interoperability, e.g. port, protocol, used video codec and registration mode.

# New rule form

Name field is only displayed in the table for rules. Host and Port fields are more important and also mandatory. They are required to determine call direction applied to this rule. Please note that it isn't possible to set different rules for one host but different ports.

/server/media/sip_form/en.png

The following block of fields are designed to authorize on a SIP device for which the rule is created. If Authorization name is identical to login, you may leave this field blank. With International call prefix you can replace "+" symbol which is used in phone numbers with other value, e.g. "810". If you leave this field blank, "+" symbol will not be replaced in phone numbers your users call to.

Registration mode defines registration method for the rule:

  • off — REGISTER request is not sent, registration or authorization on external SIP device is not performed.

  • permanent — registration is performed automatically when TrueConf Server starts.

  • before call — registration is performed before every call and is kept active only during the call.

Tip

Please note that each active gateway connection reserves one SIP/H.323 connection from TrueConf Server license.

Enable ICE support (Interactive Connectivity Establishment) checkbox makes TrueConf Server gateway available behind NAT.

Enable SRTP support checkbox is used to encrypt media data sent in this direction. For some SIP devices encryption is mandatory (e.g. for Skype for Bussiness servers).

Enable content sharing over BFCP checkbox will allow you to send and receive content from SIP devices as a second video stream. For example, it can be used to share desktop from the PC connected to SIP endpoint, or send slides back from TrueConf applications to SIP endpoints.

Enable far end camera control over Q.922/H.224/H.281 checkbox enables support for far end camera control of SIP endpoints from TrueConf client applications.

Enable timers support (RFC4028) is used for disconnecting SIP endpoint from the conference when the connection is lost.

The list of Available codecs displays the codecs which gateway is allowed to use in this direction. Disabling some of the codecs can solve compatibility issues with certain SIP devices, eg. Lifesize endpoints. For more details please contact our technical support team.

SIP device for which the rule is created can take special roles:

  • Default SIP proxy. This role allows users to avoid entering full SIP URI for calls with #sip: prefix. For example, all calls in the #sip:Endpoint format will be automatically replaced with #sip:Endpoint@Host, where Host is taken from the properties of this rule and Endpoint is a username specified during the call.

  • Default VoIP server. This role is used to treat SIP endpoint as a VoIP service or PBX. All calls made from dialers built-in into TrueConf client applications, as well as the calls dialed with #tel: prefix will be automatically forwarded to this SIP endpoint. For example, #tel:Phone will be automatically replaced with #sip:Phone@Host, where Host parameter is automatically taken from the properties of this rule and Phone is replaced with the phone number entered by user.

Please note that each of these roles can be assigned only for one SIP/H.323 connection rule.

# Skype for Business integration configuration

This integration is designed to work with Skype for Bussiness 2015 Server or Lync 2013 Server on-premises deployments and cannot be used for their cloud versions:

  1. Create a new account on Skype for Bussiness server for TrueConf Server gateway.

  2. Use Skype for Bussiness template to create a new rule for SIP connections. Enter username and password of this freshly created account in the appropriate fields.

  3. Enter Skype for Bussiness server IP address or domain name in the Host field.

  4. Check Default SIP proxy checkbox.

  5. Save the rule and check if the connection status has changed to successful in the table for rules. Please note that TrueConf Server service must be running.

To call Skype for Bussiness users from TrueConf client applications, use the following format: #sip:User, where User is TrueConf username. This user will receive an incoming call from the TrueConf Server account. The same method is used to invite Skype for Bussiness users into the conference or add them to address book.

To call TrueConf users from Skype for Bussiness client application, send the following message to the user created for TrueConf Server authentication: /call <TrueConf_ID>, where <TrueConf_ID> is any valid TrueConf Server user ID including SIP / H.323 devices registered on TrueConf Server. You can use /conf command to create a multipoint conference, etc. After the message has been sent, TrueConf Server will Skype for Bussiness user and connect him/her to a TrueConf user or a conference. If you try to call this user directly, the call will be rejected and you will receive a help message with a list of available commands in chat. However, if default call destination is set in global SIP settings, you will be connected to this default destination address.

Please note that you can also create a group conference on TrueConf Server and invite into the conference the endpoints connected via any protocols the gateway supports. For example Skype for Bussiness users and various SIP/H.323 devices or RTSP IP cameras.

# Global SIP settings section

Most of the settings in this section are identical to the settings described above. However, they automatically apply for all SIP connections for which there are no rules.

/server/media/global_settings/en.png

Other settings are described below:

  • SIP From domain. It is used to generate a SIP URI for outgoing calls in the following format user@server, where server is the entered value and user stands for the user ID who initiated the call. It is usually displayed as caller address on SIP devices.

  • Default call destination. Use this field to enter user ID or conference ID (CID) which will receive all incoming calls over SIP protocol where specific user wasn’t specified in SIP URI.

  • Reduce SIP messages size. Use this option to reduce SIP messages size and avoid possible issues related to its maximum size (MTU).

# Invitation of the SIP endpoint to the conference on TrueConf Server

There are multiple ways of inviting a SIP endpoint into a conference: conference owner can call a SIP endpoint using a specifically formatted call strings from TrueConf client application. Alternatively, administrator can do it from TrueConf Server control panel.

To add an SIP endpoint to the conference via control panel you need to:

  • Select a conference in Group conferences list.

  • Add SIP endpoint as a participant of the conference if it's not started yet, or invite in case it's already running. Use a call string to address the SIP endpoint.

/server/media/adding_sip/en.png

# Connecting SIP endpoint to the conference via CID (conference ID)

Proceed to Group conferences list and create a group conference. Take note of your Conference ID or CID (e.g. \c\e22a39ba2a).

To connect to the conference from the endpoint registered on TrueConf Server, enter CID into the endpoint address string. Please note that you need to replace \c\ in CID with 00 (two zeroes). In our case, you need to call 00e22a39ba2a@<server>.

To connect to the conference from the endpoint unregistered on TrueConf Server, use the following format:

  • CID@<server>, where CID is a conference ID with two leading zeroes instead \c and <server> is an IP address of TrueConf Server gateway e.g., 00e22a39ba2a@192.168.1.99.

  • CID@<Server>:<port>;transport=<protocol>. You can indicate non-standard port <port> for SIP connection and choose a protocol <protocol> (TCP or UDP) e.g. 00e22a39ba2a@192.168.1.99:5061;transport=TCP.

Note

You can also find an instruction on how to connect to a conference held on TrueConf Server from an SIP endpoint on the conference web page.

# H.323 gateway

This section explains how to configure built-in gateway parameters for H.323 connections. The number of rules for H.323 connections created using this section of control panel is unlimited.

Note

TrueConf Server Free version provides only one active connection through the gateway, including SIP, H.323 and RTSP protocols.

H.323 connections are generally used to call third-party video conferencing endpoints. With TrueConf Server you can also set up H.323 integration with MCU, H.323 gatekeeper and PBX, which can be useful for addressing endpoints and users registered on these devices via H323-ID or E.164 without specifying IP address of the endpoint in the call string. To call an endpoint via H.323 gateway, there is a special call string format.

/server/media/h323/en.png

# Network settings

This table contains address gateway used to listen for incoming SIP connections. By default the list is prefilled with IP-addresses provided by your operating system. You can edit this list by unchecking Listen on all IP addresses checkbox. The list of ports used for H.323 connections is available in our blog.

# Rules for H.323 connections

Here you can create specific rules for certain H.323 devices or call directions. Each rule is relevant only for specific destination address indicated in the Host field. Each rule redefines global settings for H.323 connections.

The gateway can also register on H.323 devices and maintain an active connection, which might be useful when connecting to an MCU or gatekeeper. The status for such connection is displayed in the rules table. To create a new rule, click Add configuration button.

# New rule form

Name field value is used only to distinguish one rule from another. Host and Port fields are also mandatory. They are required to determine call direction to which this rule will be applied. Please note that it isn't possible to create different rules for one host but for different ports on it.

/server/media/h323_form/en.png

H323-ID and Password fields can be provided to authorize on H.323 device for which the rule is created. To maintain permanent connection with this device, you’ll need to select necessary item in the Registration drop-down list.

Once successfully registered on the H.323 device, TrueConf Server can be reached via phone number in the E.164 format provided it has been specified in the DialedDigit field. This setting can be useful if bundled with Default call destination option in the global H.323 settings section. In this case all calls to the specified DialedDigit number outcoming from the connected H.323 device will be redirected to a specific user ID or conference ID on TrueConf Server side.

Tip

Please note that each active gateway connection reserves one SIP/H.323 connection from TrueConf Server license.

Enable H.235 encryption checkbox enables encryption of the media streams sent to H.323 devices according to ITU-T H.235 version 3 recommendations. It is required for proper interoperability with some endpoints.

Enable content sharing over H.239 checkbox allows to send and receive content from H.323 devices as an additional video stream. For example, it can be used to share desktop from the PC connected to H.323 endpoint or to send content from TrueConf applications in the opposite direction.

Enable far end camera control over Q.922/H.224/H.281 checkbox enables support for far end camera control of H.323 endpoints via Q.922, H.224 and H.281 protocols from TrueConf client applications.

The list of Available codecs displays the codecs which gateway is allowed to use in this direction. Disabling some of the codecs can solve compatibility issues with certain H.323 devices.

H.323 device for which the rule is created can take special roles:

  • Default H.323 gatekeeper. This role allows users to avoid entering full address of the H.323 device using #h323: prefix. For example, all calls in any direction in the #h323:Endpoint format will be automatically replaced with #h323:Endpoint@Host, where Host is taken from the properties of this rule and Endpoint is a username specified during the call.

  • Default VoIP server. This role is used to take H.323 device as telephony service or PBX. All calls made from dialers built-in into TrueConf client applications, as well as the calls dialed with #tel: prefix will be automatically forwarded to this H.323 device. For example, #tel:Phone will be automatically replaced with #h323:Phone@Host, where Host parameter is automatically taken from the properties of this rule and Phone is replaced with the phone number entered by user.

Please note that each of these roles can be assigned only for one H.323 rule.

# Global H.323 settings

Most of the settings in this section are identical to the settings described above. However, they automatically apply for all H.323 connections for which there are no rules. Use Default call destination field to enter TrueConf ID or conference ID (CID) which will receive all incoming calls over H.323 protocol in cases where destination user ID wasn't specified.

/server/media/global_settings_h323/en.png

# How to call TrueConf users and conferences from H.323 devices

Depending on the H.323 endpoint model there are two different methods to call TrueConf Server users and conferences: using SIP URI or hashes (##) notation. Please try both to find the one suitable for your H.323 equipment. The call strings provided below should be entered as a string or number to call in the endpoint’s interface. TrueConf Server IP address mentioned below could be an any address specified in H.323 network settings section.

  • Server##User, where Server is TrueConf Server IP address and User is ID of the user or device registered on TrueConf Server.

  • User@Server, where User is ID of the user or device registered on TrueConf Server and Server is TrueConf Server IP address.

  • \c\CID@Server, where CID is ID of the conference on TrueConf Server and Server is TrueConf Server IP address.

  • 00CID@Server, where first two characters are zeroes, CID is ID of the conference on TrueConf Server and Server is TrueConf Server IP address.

Tip

For TrueConf Server ver. 4.3.9 or older the following notation is used:

  • \c\CID@Server, where CID is ID of the conference on TrueConf Server and Server is TrueConf Server IP address.

  • \\c\\CID@Server, some endpoints require back slashes in a call string.

# How to register H.323 devices on TrueConf Server

TrueConf Server can act as a gatekeeper or MCU for third-party H.323 devices and simplify their addressing. From the TrueConf Server user perspective an H.323 device registered on the server does not differ from any other user: you can see its status, call it from the address book or invite to the conference without using call strings notation. Similarly, calls using H323-ID names from a registered H.323 device interface will be interpreted by the server as a call to specific TrueConf ID to entered H323-ID.

Registering an H.323 device on TrueConf Server is similar for most endpoints available on the market. Basically, to do so, you will need to specify TrueConf Server address as a gatekeeper or MCU address and use username and password of any TrueConf Server account to authenticate.

# How H.323 endpoint can call TrueConf Server user

Registering H.323 endpoints on TrueConf Server is similar for most endpoints available on the market. Enter TrueConf Server address as an H.323 gatekeeper or MCU address and enter username and password of the TrueConf Server account, on behalf of which the device will call.

# Transcoding

This section enables you to set up video conferencing quality for WebRTC users (in browsers), H.323/SIP/RTSP devices and recording fixation.

/server/media/transcoding/en.png

Cheking the box Do not display self-view in video layout for H.323 and SIP endpoints allows displaying the conference layout for SIP and H.323 devices without your video window.

Tip

This setting can significantly increase the load on the CPU of the physical machine with TrueConf Server installed.

When the box Use GPU to reduce CPU load is checked, video conferences will be processed by the GPU of the physical machine with TrueConf Server installed.

# Web

This tab contains settings of external web pages that are available to unregistered users.

# Settings

/server/media/settings_web/en.png
  1. TrueConf Server address used to build guest page links and scheduled web conference links.
  2. A link to the guest page which contains instructions on how to connect new users to TrueConf Server.

  3. Your company's name which will be displayed on the guest page.

  4. Server administrator contact details which are published on the guest page and web conference pages.

  5. Custom logo upload form for the guest page.

# Web security

/server/media/security_web/en.png

1. Select Windows users who will have administrative access.

Tip

Users of the Administrators group also have access to the server administration.

2. By default accessing and managing the server from the IP addresses specified below does not require user authorization. Disabling this option will make authorization mandatory for all users.

Warning!

Before unchecking this box make sure there is an account of the user added to the group on the computer where TrueConf Server is installed. Otherwise you won't be able to authorize and enter TrueConf Server control panel after the changes have been applied. If it did happen, please reinstall the server or contact TrueConf technical support.

3. Check this box to limit access to your server to the IP addresses specified on the list.

4. Press this button to add a subnetwork with access to the control panel. Add the address in the Network address field (admissible symbols are numbers and dots, admissible format is 4 octets in decimal representation without initial noughts from 0 to 255, separated by dots, e.g. 192.168.11.10). To open a drop-down list in Subnet mask field click the arrow on the right side and choose the appropriate option. 32 - 255.255.255.255 mask is set by default.

5. Secret security key for accessing API of your TrueConf Server.

Warning!

If you have a secret key, you can have permanent access to API until the key is changed. Hence we recommend using the secret key only for testing API, and using OAuth2 for regular work with it.

6. Click to generate a new secret key. Reverting to the previous key or using your own is not possible.

7. Click to apply the changes.

# HTTPS

In this control panel section you can configure the safety data transfer parameters between your browser and TrueConf Server.

/server/media/https/en.png
  1. Select one of the three operating modes:

    • Disable HTTPS. HTTPS protocol will not be used.

    • Use self-signed certificate. This mode uses a certificate automatically obtained from the server (this certificate is not suitable for connecting external users via WebRTC).

    • Use custom certificate. This mode uses a certificate uploaded by the TrueConf Server administrator.

2. Click here to go to the full user guide in our blog.

3. Set TCP port which will be used by web server for operating via HTTPS protocol (it is required to use numbers). Port 443 is set by default.

4. Specify which protocol versions are supported by your server (select at least one version).

5. Click this button to verify the HTTPS configuration data without restarting the web server. This action does not change the configuration file of the Apache web server.

6. Click this button to save a web server configuration file and restart the server. Upon clicking on this button a dialogue box will appear, notifying the user that this action will lead to a reboot of the server. TrueConf and Apache reboot processes start up simultaneously because TrueConf Server uses the same certificate to run WebSockets WSS secure channel.

7. Generate a new certificate. The Self-signed certificate section will appear as shown on the picture only if this certificate type has not been issued before. If the certificate was issued before, this section will contain the main parameters of the root certificate and certificate which was used by the web server and the TrueConf Server.

8. Select the appropriate certificate and key files and click Upload. The Custom certificate section looks like this only if this certificate type has not been issued before. If the certificate has already been downloaded, this section w contain the main certificate data (see Custom certificate segment below).

Safe connection channel between browser and server is essential for in-browser media capture using WebRTC technology for Google Chrome (starting from version 47).

# HTTPS configuration

In this section you can select your certificate and set other HTTPS parameters. The web server applies HTTPS settings at startup. If invalid certificate port and parameters are entered, the web server will not start and administrator will lose access to the control panel. Therefore it is required to carefully check the parameters beforehand. Press Test configuration for your server to check if your HTTPS port is available.

# Self-signed and custom certificates

There are two certificate types available in TrueConf Server. If you are using a trusted certificate, no additional actions are required, as browsers trust certificate authorities who signed it. To configure an uploaded certificate, the server administrator requires an X.509 certificate and the correct private key.

As an alternative you can also use a self-signed certificate:

  • a self-signed certificate is valid for 365 days and can be generated from control panel

  • this certificate can be renewed for unlimited period of time

  • with a self-signed certificate, you can test WebRTC without purchasing a trusted certificate

# Self-signed certificate

/server/media/samopodpisanniy_sertifikat/en.png

To create a new self-signed certificate, press Create new SSL certificate. You may use this option to renew your certificate for 365 days or to update information about your company in the certificate (if your company’s name has changed). Administrator can download a root certificate file for sharing among client devices via the link Download ca.crt.

# Custom certificate

If the certificate has already been downloaded, this section will contain the basic parameters of the certificate:

/server/media/zagruzhenniy_sertificat/en.png

The certificate format, key format and key correspondence to certificate are checked during download. Should just one check fail, the certificate and key files will not be not saved.

# Users

# User accounts

In the Users Accounts section you can add new user accounts, as well as edit and remote existing user accounts.

Tip

The maximum number of user accounts in TrueConf Server Free is 12.

/server/media/uchetnye_zapisi/en.png
  1. Add a new user.

  2. Search for users.

  3. View user groups available on the server.

  4. List of users, registered on the server. User status is indicated in colored, square shaped icons displayed to left of the TrueConf ID:

    • Green color – the user is online

    • Red – the user is offline

    • Yellow – the user is in a conference

    • Yellow star – the user is the owner in the conference.

In order to change user information, click on the username. To remove a user, click on the trash button.

Tip

You cannot edit user details in LDAP mode. User data entry form is available only in Registry mode.

# User profile

Click on any user account in any control panel section to proceed to edit mode:

/server/media/user_profile_fields/en.png
  1. Switching user to active or inactive status. If the status is inactive, the user account still exists, but the user cannot log-in to his/her TrueConf client application.

  2. Disconnecting user from the network. You may use this option to allow another user to connect to server, when the maximum number of connections in your license has been reached.

  3. A unique name used for signing in to the client application and making calls. Username may contain only Latin characters, numbers, underscores, hyphens, and points. Server name indicated after the username (@<server> next to the input field) is required for calling a user from another server. The username is set when creating a user and cannot be changed afterwards.

  4. User password. You can change your password anytime.

  5. The email address to which user notifications will be sent. Please refer to the SMTP configuration of the TrueConf Server.

  6. The name you have entered will be displayed in the address book of other users. This field is prefilled as <ID>@<server>, where <ID> is the username you have entered at the step 3, and <server> is the name of your server. However, field value can be changed.

  7. User’s personal details. These fields are not required.

  8. Defines user group. Click the arrow icon to view existing groups on the server. To add a user to the group, check the field to the left of the group name.

  9. User’s mobile, work or home phone number.

  10. Save changes in user account. Remove user account. Go back to the previous page.

At the bottom of the page you can select additional settings that will be activated in client application when the user signs in. These settings define input and output bitrate limits.

If such settings have not been configured, user group settings (if configured) are applied to the user. User group settings are displayed next to the user settings field. They are displayed for preview only and cannot be changed.

Tip

User application settings have higher priority than group settings: if you put user restrictions lower than group restrictions, user restrictions will be applied.

/server/media/user_profile_application_settings/en.png

Note

Users can independently change bitrate settings in their client applications. But the server settings will have the highest priority.

At the bottom of the page you can find the address book and edit buttons. The address book contains all the users who are located in the address books of the user groups where the user belongs.

You can add individual user addresses to the address book of the user being edited. Please note that you can add not only TrueConf Server user, but also SIP/H.323 or RTSP users to the address book.

/server/media/user_profile_address_book/en.png
  1. Interface used to add a user into the list. Start typing user’s name and you will see name options in the drop-down list.

  2. The list of the groups to which the user belongs and address books in which the user’s address book (no option to remove data).

  3. Search for users.

  4. User profile from the address book.

# Groups

In Groups tab you can create, rename, edit and delete groups. You can also add or remove users from the group, set up their address book and configure individual settings for the users of any group.

To add a new group, enter its name and press Create.

/server/media/groups/en.png

The newly created group will appear in the list of groups.

At the group level you can allow or forbid:

  • Editing address book. By checking this field, administrator allows users to change users display names of the users, delete/add users and perform any other changes in the group’s address book. If the box is not checked, group users will not be able to perform the actions mentioned above. In this case, all changes are performed by administrator in TrueConf Server control panel and extend to all address books of the users from this group.

  • Making point-to-point video calls. However, users can still receive incoming calls.

  • Content sharing and slide show.

  • Creating group conferences.

  • Operator rights. Operator right enables a group participant to become a moderator of any conference he or she joins.

These settings allow you to distinguish between different server users.

# Editing group list

Click on the group name to open the page User Accounts. On this page you can rename a group and add users to any group. To add a user to the group, press Add user:

/server/media/nastroyka_gruppy/en.png

In the window that opens, select the users you want to add to the selected group. After that they will be marked with a checkmark. Once all users are selected, click Save.

/server/media/add_user_in_group/en.png

All selected users will be displayed on the group page:

/server/media/group_with_users/en.png

Click Rename to change the group name. Enter the new name and press Save (or press Cancel if you want to close the window without changing the settings):

/server/media/rename_group/en.png

# Setting up address book for users of the group

Click Customize in the Address book column to open edit menu of the common address book for all users of the current group. Group members can add new contacts in the address book if they have corresponding rights. To grant such rights, Address book editing box should be checked in the main table.

You can add all users belonging to another group at once to the group’s address book (i. e. to the address book of each of its members). To that end, use Define, which users will be shown in the address book of the users in the group. Please note that automatic addition of users to the address book and manual addition are applied independently of each other.

/server/media/group_address_book/en.png

Users of a specific group can search for other server users and add them to their address book (if editing address book is allowed).

# Setting application settings for group users

Click Customize in Application column to set bandwidth limits for the group users.

/server/media/group_application_settings/en.png

# Aliases

Thanks to aliases, you can call TrueConf Server user or any other user who can be called via the server (e.g. SIP, H.323, RTSP or other server users) using a short alias without entering full call string. By adding an alias, you create an extra name for existing user. When calling an alias, your call is redirected to the existing user corresponding to this alias.

This option is very useful for those users who are making calls to TrueConf Server users from mobile devices using a dialer. You can create digital aliases for server users so that they can be called from mobile devices.

/server/media/psevdonim/en.png
  1. An alias may contain numbers and letters. The maximum number of characters is 32. You can update aliases only after restart you have restarted the server.

  2. Call string (including username of the server user). The calls to the alias will be forwarded to this user.

  3. Press the button to add a new alias to the list.

  4. To delete an alias from the list, check the box on the left and press the button.

Tip

After adding or removing aliases, please restart your server to update the list of aliases.

# LDAP / Active Directory

Tip

Syncing server with LDAP is unavailable in TrueConf Server Free version.

Switching between user data storage modes. TrueConf Server supports two types of data storage: Registry and LDAP. You can switch to any type by pressing Switch button:

/server/media/rezhim_hraneniya/en.png

# Registry mode

Registry mode is used by default. In this mode, the server contains information about the users on the local server. You can add or remove users via control panel. If the server has been switched from Registry to LDAP data storage mode, existing user records will not be used anymore.

When switching to LDAP data storage mode, user records stored on the local computer will not be removed, so switching to another data storage mode will not damage saved information.

# LDAP mode

In this mode the server operates information about the users from removed or local LDAP directory. In LDAP mode you cannot edit user list and user group settings via control panel. By default, configuration settings for LDAP match Microsoft Active Directory. User information is edited using Active Directory management tools.

In LDAP mode, user rights correspond to the Active Directory group where users belong. To activate this mode, check LDAP → Enable and press Settings LDAP button at the bottom. LDAP settings window will open:

/server/media/ldap/en.png
  1. Server type.

  2. In the automatic mode the LDAP server can be chosen among the servers by default of the DNS domain, specified in this field. Default servers are being chosen according to the relevant DNS-notes of SRV type. For Active Directory DNS domain name AD can be indicated here.

  3. Connection to the LDAP in the safe mode. Only in this case safe transmission of the user information through the network is ensured.

  4. LDAP server address and port.

  5. Automatic choice of the LDAP server.

  6. Manual choice of the LDAP server.

  7. Base Distinguished Name is a directory object designed for searching users, e.g. ou=People,dc=example,dc=com.

  8. TrueConf Server authorization modes on the LDAP server.
  9. Authorization parameters on the LDAP server.

  10. After choosing this option the users can automatically get authorized in the system by using the current Windows user account. The option is available only for the systems working on the basis of Microsoft Active Directory. For NTLM authentication work it’s necessary that the server on which TrueConf Server software is installed is located in the same AD domain with the users.

  11. For Active Directory in this field it’s possible to indicate LDAP group of users, who can get authorized on the TrueConf Server, e.g. cn=TC_Users,ou=People,dc=example,dc=com. To choose an LDAP group using the Browse button you need to fill in the spaces for connection to the LDAP server (Server Settings and Authentication), including Base DN field.

  12. Additional LDAP parameters. Allow to adjust the parameters to other types of LDAP servers.

  13. Back on page User storage.

When changing from LDAP Mode to Registry mode it is possible to import user data. To do this, choose the Registry mode in the User storage tab, tick on Import User Information and click on Switch.

Tip

User passwords are not imported. After being imported the user accounts are inactive (see User accounts section).

Directory of groups and users registered on TrueConf Server. This tab allows to create and manage the user’s groups. User Accounts tabs allows creating groups and managing rights. In the Registry mode a user can belong to one (or more) created groups. This parameter can be edited in the edit user information window. In the LDAP mode this window allows you to define rights for several LDAP groups. User attribute can be defined in the LDAP folder.

Note

On the server the Users without group is created by default.

# Group conferences

This section enables the server administrator to pre-schedule conferences, define lists of participants, and other parameters.

These conferences can be launched automatically (at a specified time or according to a schedule) or by the server administrator at the click of a button.

# Conference List

/server/media/conference_list/en.png

  1. Add group video conference.

  2. Conference ID.
  3. Click on the link to open the dialog containing the html code for embedding the conference on external websites.

  4. Conference forced start. Before the start you will be offered to invite all the participants to the conference or select particular users. At conference forced start, only online users will be invited to the conference. Email invitations will not be sent out.

  5. A link for conference page.

  6. Edit selected conference.

  7. Remove selected conference.

# Creating video conference

Click on the Create button in the Conference List menu to select a conferencing mode and schedule type.

/server/media/create_conference_select_access/en.png
  1. Create a new conference or select one of the previously saved conference templates.

  2. Indicate the conference type: scheduled meeting or a virtual room.

  3. Select conference type:

    • Private conference is hold among TrueConf Server authorized users and third-party SIP/H.323 or RTSP endpoints (if such endpoints are assigned with user ID). Unauthorized user cannot connect to a private conference.

    • Public conference (if checked) can be joined by external users (guests) without authentication. If your license does not allow you to create such conferences (check the Public Web Conferences extension), Make the conference public checkbox will be inactive.

# "General" tab

/server/media/general_tab/en.png
  1. Conference Name Field, e.g. "Marketing Department Meeting".

  2. Select the conference owner.

Note

When scheduling a conference, the administrator assigns the conference owner (who automatically becomes moderator) and other moderators. Other roles will be given by users in a conference.

  1. Select a video conferencing mode: symmetric, asymmetric or role-based.

Note

The maximum number of participants in a role-based conference depends on your license type. The number of participants can reach 800 users. The maximum number of speakers in a role-based conference is 36.

  1. Setting time and regular schedule for your video meeting.

Tip

If you have selected Virtual Room type when creating the conference, this item will be unavailable.

  1. Save conference settings as a template. In future you will be able to create a conference with such settings in one click.

# "Participants" tab

This tab shows the number of participants added to the conference depending on the conference mode. Participants can be added to the conference from the user list, by ID or by email (for public conferences).

/server/media/participant_list/en.png

Adding by ID

Enter user ID or call string for SIP/H.323/RTSP devices to the search field in the Contacts tab, to make the user conference participant.

/server/media/add_id/en.png

Adding email to send an invitation

To invite a user to the conference, proceed to E-mail tab fill in Name and Email fields, and press Add:

/server/media/add_guest/en.png

Tip

This feature is available only in public conference mode.

How to Make a Participant a Moderator

  1. Select a user from the list of added conference participants and click three dot button.

  2. Press Assign as a moderator.

/server/media/assign_as_moderator/en.png

The participant appointed as a moderator is marked with a star icon.

# "Layout" tab

On this tab you can set video layout (combination of participants' video windows).

/server/media/layouts_tab/en.png
  1. Select a video layout: general (for all participants) or individual (for a particular participant or SIP/H.323 device).

  2. Remove unnecessary layout.

  3. Add a new layout.

  4. Specify the largest video window in a layout.

  5. Select the number of participants' video windows in a layout.

  6. Add an additional video window to a conference layout to broadcast content.

  7. Go to the layout preview in full screen mode.

  8. Fill a layout automatically for a preview.

  9. Clear layout.

  10. Edit a conference layout. You can move a video window of a particular participant or make it larger.

  11. Username caption on the video window.

  12. Forbid conference participants from changing layouts.

# "Advanced" tab

/server/media/additional_tab_private/en.png
  1. Allow users to join the conference without invitation (for internal conferences only).

  2. Press to configure video conference recording (see Recordings section).

  3. Press to setup streaming.

  4. Select the streaming preset (see Streaming).

  5. Turn on UDP Multicast mode. With UDP Multicast you can use network resources more efficiently because conference participant streams are directed bypassing the server. In this mode video and audio streams are transferred inside UDP Multicast domain. These domains can be used in the local network or VPN. Please check your license to see if this mode is available for you.

Warning!

If UDP Multicast mode is enabled while you are trying to connect to the conference using third-party protocols (WebRTC, RTSP, SIP, H.323, etc), video conference recording and streaming will be unavailable.

Enabling this function is recommended only for those users who have hands-on experience in the sphere of network administration. Please note that it is your responsibility to check if this technology is available in your network.

  1. The field to indicate Multicast/Broadcast IP address. By default it is 224.0.1.224:4000-6000.

  2. Enable email invitations for conference participants. This option is available only if SMTP server integration is set up.

  3. Adding guide text to the scheduled event (e.g. presentation description or event program). This text will be displayed on the conference page.

If you check the box Public conference when creating the conference, this tab will also contain the following parameters:

/server/media/additional_tab_public/en.png
  1. Set up conference ID to make it easier for the users to connect to the conference.

  2. Set up permissions for guest users.

Tip

WebRTC conferences are available for Chrome, Opera, Mozilla Firefox, Edge and Safari users. The license regulates guest connections for WebRTC conferences.

# Templates

This section allows server administrator to create new conference templates and edit saved ones. Templates can also be saved while editing conference. Conference template includes information about conference mode, participant list, conference owner, as well as additional parameters.

Creating and editing templates is very similar to creating and editing conferences.

/server/media/template_list/en.png
  1. Create a new conference template.

  2. Use a saved template to create a conference with typical parameters.

  3. Edit saved conference template.

  4. Delete unnecessary template.

# Streaming

In this section, you can create and set streaming configurations used for setting up a conference.

/server/media/streaming/en.png

To create a new configuration, click Add configuration button.

/server/media/add_streaming_configuration/en.png

# Streaming through CDNvideo cloud service

Click on Automatic Setup to create a new account at CDN video service. To continue please make sure that a PC with installed TrueConf Server on it is connected to the Internet:

/server/media/streaming_CDN/en.png
  1. Selected template for current streaming configuration.

  2. If you already have a CDNvideo account, click on this link to enter your username and password.

  3. Email address that will be used to create a new CDNvideo account. TrueConf Server administrator email is used by default.

  4. By creating a CDNvideo account you agree with CDNvideo terms of use.

  5. Return to streaming configurations list.

  6. Save current streaming configuration.

How to connect to CDNvideo streaming

Conference streaming is available on any Intranet or Internet HTML page with CDNvideo video player widget embedded on it. The streaming will start automatically when participants join the conference or, in case it is a role-based conference, when the first participant takes the podium. Widget code is unique and is setup to stream only current conference.

/server/media/html_vidget/en.png

How do I get the code for CDNVideo video player?

  1. Go to the conference list page.

  2. Select a conference pre-configured for streaming.

  3. Click the link Display conference details in the side menu of the page.

  4. Follow the link next to Integration.

  5. Copy the code of the video player widget.

# Streaming via third-party services and products

This section includes ready-to-use templates for popular streaming services and products, designed to work in corporate networks and via the Internet. Press Add configuration to choose a template to start with:

/server/media/streaming_wowza/en.png
# Wowza Streaming Engine
/server/media/streaming_engine/en.png
  1. Configuration name displayed in streaming configuration list on the conference edit page.

  2. Address of the Wowza Streaming Engine.

  3. Wowza Streaming Engine accepts connections on this port (e.g. 1935 or 1940).

  4. You can find necessary information in Wowza Streaming Engine user’s guide.

  5. Check Authentication to enter username and password to access Wowza Streaming Engine if required.

  6. This section includes additional settings for current streaming configuration (see Advanced streaming settings in present user’s guide).

# Wowza Streaming Cloud
/server/media/streaming_wowza_cloud/en.png
  1. Link to the instruction on how to setup streaming through Wowza Streaming Cloud in our blog.

  2. Configuration name displayed in streaming configuration list on the conference edit page.

  3. Wowza Streaming Cloud accepts connections on this port (e.g. 1935 or 1940).

  4. This section includes additional settings for current streaming configuration (see Advanced streaming settings in present user’s guide).

A more detailed instruction on how to stream the conferences via Wowza Streaming Cloud is available in our blog post.

# YouTube
/server/media/streaming_youtube/en.png
  1. Link to the instruction on how to setup streaming via YouTube.

  2. Configuration name displayed in streaming configuration list on the conference edit page.

  3. Server URL from the webpage where YouTube stream is created.

  4. Stream name/key from the webpage where YouTube stream is created.

  5. This section includes additional settings for current streaming configuration (see Advanced streaming settings in present user’s guide).

# Manual settings

This section allows you to manually setup streaming for the majority of existing streaming services and products, including those listed above. TrueConf Server supports two ways of content transmission: RTSP Publish (aka RTSP Push) and RTSP Pull. When using RTSP Publish, your server notifies streaming platform about content available to be picked up. When using RTSP Pull, the platform itself collects the content from your server.

# RTSP Publish manual settings
/server/media/streaming_publish/en.png
  1. Configuration name displayed in streaming configuration list on the conference edit page.

  2. The address which will be used to notify about available stream via RTSP ANNOUNCE protocol.

  3. Check Authentication to enter username and password and gain access to the service.

  4. This section includes additional settings for the current streaming configuration.

# RTSP Pull manual settings
/server/media/streaming_pull/en.png
  1. Configuration name displayed in streaming configuration list on the conference edit page.

  2. This section includes additional settings for the current streaming configuration.

# Additional streaming configuration settings
/server/media/additional_streaming_settings/en.png
  1. You can change video codec used for the stream encryption.

  2. You can change audio codecs used for the stream encryption.

  3. Check if you need to send outbound RTP streams via TCP protocol. UDP is used by default.

  4. Response waiting time (in seconds) for the information about published conference stream being successfully received by streaming platform.

  5. In case connection with streaming platform is terminated, TrueConf Server will attempt to publish the stream again. This parameter sets the number of such attempts.

  6. Delay (in seconds) between stream publication attempts.

  7. Return to the conference editing.

  8. Save the settings.

# API

# OAuth2

This section is used to manage applications or services which utilize TrueConf Server API. Permissions are controlled based on OAuth 2.0. protocol. You can learn more information about OAuth 2.0. protocol in RFC 6749 official documentation or in the note below. Please note that it is no longer recommended to access API via secret key in Web → Security section as this option will be deprecated in one of the following TrueConf Server versions.

Note

Oauth 2.0 is used to authorize certain applications (clients) to access protected resources with limited scopes and rights. With this approach, you can block a particular application or a user from the server resources at any given period of time. The protocol also allows you to authorize third-party applications and do actions on the server on behalf of the user via API. In this case, the user does not need to give their username or password to any third-party application (Authorization Code method).

After authorization on TrueConf Server using OAuth 2.0 protocol, every third-party application obtains an access token. Those applications with a valid access token can access TrueConf Server API. The list of API commands can be found in [TrueConf Server API documentation]. TrueConf Server administrator can manage third-party application permissions and access tokens obtained via this section.

Note

Learn more about TrueConf API use cases in our blog.

After successful authorization, the application receives access token with a limited lifespan and scope (server wide or limited to a specific user). For example, server wide scope gives information about any conference on the server, while user’s scope provides the information only about those conferences where the user is the conference owner or a listed participant. The scope is defined by the authorization type selected by a third-party application developer, while permissions set (rights) are determined by TrueConf Server administrator for every application.

OAuth 2.0 authorization method Access token scope Authorization result
Client Credentials
The client gets access token, the scope of which is server wide. User authorization is not performed. This method is recommended for trusted applications only.
Server wide Access token valid for 24 hours is issued.
User Credentials (a.k.a. Resource Owner Password Credentials Grant)
To obtain access token, it is required to provide username and password received on the application side.
User’s scope Access token valid for 24 hours and (refresh token) valid for 14 days are issued.
Authorization Code
Access token is issued after user has successfully authorized on TrueConf Server special web page. The application cannot access username and password of the user.
User’s scope Access token valid for 24 hours and refresh token valid for 14 days are issued.
Refresh Token
This method is used to obtain a new access token based on your existing refresh token.
Equal to scope of the user who has received refresh token initially Access token valid for 24 hours is issued. This method cannot be used to obtain new refresh token.

When requesting an access token, it is required to indicate Application ID and Secret. These parameters can be obtained and updated by creating or editing the application in this section. Application ID is created automatically and cannot be changed later. By contrast, application secret can be further regenerated.

Tip

Some applications cannot be removed from the list of existing apps, e.g. trueconf_slack_agent, which is created when connecting TrueConf Server to an existing Slack team. To remove it, you’ll need to disable this integration in the Manage add-ons section of TrueConf Server control panel.

# Permissions

API capabilities of a third-party application depend on the permissions it obtained.

Permission Description
conferences:read Reading conference details
conferences:write Creating, editing, and deleting a conference
conferences.records:read Reading conference recording details
conferences.records:write Deleting conference recordings
conferences.participants:read Reading the list of conference participants
conferences.participants:write Creating, editing, and deleting conference participants
groups:read Reading user group information
groups:write Creating, editing, and deleting user groups. Unavailable in LDAP mode
groups.users:read Reading the group user list
groups.users:write Creating, editing, and deleting group users. Unavailable in LDAP mode
users:read Reading server user information
users:write Creating, editing, and deleting server users. Unavailable in LDAP mode
users.addressbook:read Reading contacts from user address books
users.addressbook:write Creating, editing, and deleting contacts in the user address book
templates.conferences:read Reading conference template details
templates.conferences:write Creating, editing, and deleting conference templates
directory:read Reading TC Directory
directory:write Changing TC Directory
directory.servers:read Reading TC Directory servers
directory.servers:write Creating, editing, and deleting TC Directory servers
logs.calls:read Reading the conference list from server logs
logs.calls.participants:read Reading the list of conference participants from server logs
logs.calls.invites:read Reading the list of invited users from server logs

Each method is assigned with a set of permissions required for successful method call. All sets of permissions are specified in TrueConf Server API documentation.

# Creating new OAuth 2.0 application

/server/media/api_oauth/en.png
  1. Name is only displayed in the application list.

  2. Redirect URL field is only used for Authorization Code method. For other authorization methods please indicate the following address https://localhost/.

  3. Permissions set which is described in the previous section.

  4. Don’t forget to save the information to create a new application.

# Editing application

On the application page you can not only edit its properties but also view access token list obtained by the application’s users. You can remove user access tokens at any time to block particular user from accessing API data.

You can also Regenerate the application secret to block the application and its new users from accessing the server for security purposes. Please note that access tokens and refresh tokens obtained using previous application secret will still be valid within their lifespan.

# Reports

This section stores all information about user connections, calls, messages, and video conference recordings. Data can be filtered according to various parameters and downloaded in CSV format. In the tables, time is displayed according to the time zone selected in the preferences menu.

On the right of some of the tables there’s a dashboard containing detailed information about an event reflected in a corresponding table. Dashboard content changes when you select a table row.

These tables have common functions:

/server/media/report_table_hat/en.png
  1. Filter entries.

  2. Save tables in CSV format.

  3. Sort entries by field values (click on any column name to change sorting order).

# Events

The events section contains all changes of user states that are recorded sequentially: login, logout, etc. Click on an event in a table to check detailed information, e.g. client applications or IP address used to log in or user status changes.

/server/media/events_history/en.png
  1. General table interface (see the description above).

  2. Link to an active user profile.

  3. Event details.

# Call history

This section contains history of video calls and conferences hold on the server, as well as available information about the meetings.

# Call list

You can find call information in the table on the main page of the section. Along with call history, call list contains information about current conferences. End field remains blank for current conferences.

/server/media/call_history_main/en.png
  1. General table interface (see the description above).

  2. Link to the page with detailed information about a call or conference.

  3. Link to a profile of the conference or call owner.

# Call or conference information

When you click on a call or conference ID in the general table, you proceed to the menu that displays information about the selected call. This information includes:

  • time and information about the conference owner

  • list of the participants who attended the conference anytime

  • history of conference invitations and reactions.

/server/media/single_conference_info/en.png
  1. General table interface (see the description above).

  2. Conference chat history button.

  3. Link to user profiles of conference participants and invited users.

  4. Link to the pages with each conference participant connection details.

# Connection properties

For each participant you may get the information about all the conference connection details — from the client application version to an operating system and CPU.

/server/media/single_call_connection_properties/en.png

# Chat messages

Chat Messages section features all messages sent by server users to each other and during video conferences. Please note that one table contains time sorted messages from all users at once (you can change sorting features in the table header.) To view messages in personal or common chat, you can filter by Sender, Recipient, Conference ID, and message date.

/server/media/chat_history/en.png
  1. General table interface (see the description above).

  2. Links to user profiles of the sender and recipient of a private message.

  3. Link to a page with detailed information about the conference to the common chat of which a message was sent.

# Configuration Changes

This section displays the history of server settings changes. Each table entry corresponds to a particular change. When you click on an entry, a panel on the right displays server settings before and after the changes have been made.

/server/media/changing_settings_history/en.png
  1. General table interface (see the description above).

  2. Name of the modified parameter.

  3. Previous parameter value (before making changes).

  4. New parameter value (after making changes).

# Conference recordings

This section contains a list of recorded conferences. Conference records can be downloaded or deleted here.

/server/media/recordings_list/en.png
  1. General table interface (see the description above).

  2. Link to the page with detailed information about a call or conference.

  3. Link to a profile of the conference or call owner.

  4. Conference type: video call, symmetric, asymmetric or role-based.

  5. Recording download button.

  6. Delete button.

# Endpoints

This section provides information about user endpoints. This information can be useful for real time technical support.

/server/media/podkluchenie/en.png
  1. Select the number of displayed connections in the table.

  2. Field used to search for a connection. The system searches through all fields (once a table has been filtered, the system displays only those records that have at least one field with string entered).

  3. Unique connection ID.

  4. TrueConf ID of the users who are currently connected to the server.
  5. Name of the user’s client application and application version.

  6. User IP address.

By clicking on the table entry, you can see the pages containing information about a particular user connections. This page may include information about:

  • available playback and audio capture devices

  • available video capture devices

  • selected equipment settings

  • the latest conference where a device participated

  • DirectX properties

  • network connection

  • network test results.

/server/media/single_endpoint/en.png

# Events that update device information

Event Variable Fields
Connecting or reconnecting device to the server
  • Network Info Type
  • Audio Capture
  • Audio Render
  • Video Capture
  • Direct X
  • Hardware Config
Conference end Last Conf Name
Taking network test (by clicking a corresponding button in the client application) Network Test
Authorization on the server System information

# File storage

In this section you can setup storage settings for files your users are exchanging:

/server/media/file_storage/en.png
  1. Select a location of the files directory. You can use network paths.

  2. Available free space on logical drive used for storage.

  3. File lifetime (in days) before the files are removed automatically. Start time is the first file upload. The files are stored for 7 days by default. Minimal value is one day, and maximal value is unlimited.

  4. Use the slider to set maximum download speed limits to download the files from the server.

  5. Use the slider to set maximum upload speed limits to upload the files to the server.

  6. Save changes.

# Recordings

In this section, you can adjust the server settings for automatic conference recording.

/server/media/conference_recording_settings/en.png
  1. The path to the folder where all recordings are saved. Default Recordings folder is located in the server working folder. The list of recorded conferences displays the videos from the specified folder. If the path is redefined, the list is re-formed respectively. In this field, you can also specify network path if TrueConf Server service has the rights to place recordings in this directory.

  2. Enable/disable point-to-point video call recording. This option is similar for all calls: either all are recorded, or none are recorded. Please note that if you enable this option, you will not able to use direct connection between users (to be recorded, all information between subscribers is transferred through the server).

  3. There are three options to set up group conference recordings: either all are recorded, or none are recorded, or recording is set separately for each conference ("on demand" mode).

  4. Video format of conference recording.

  5. Time (in days) after which conference recordings should be deleted automatically. Click the checkbox next to the field to activate the text field. If you don’t check this box, recordings will be stored indefinitely (recordings are not deleted automatically).

Can the video recorded with TrueConf app be played using third-party programs?

Yes, it can. In order to do it you will need to download and install a media player with VP8 video codec support, e.g. VLC.

You can also upload any of your recordings to YouTube to share with your colleagues.

How to publish a conference recording on YouTube:

  1. Download the recording.

  2. Upload to YouTube.

# Manage add-ons

# TrueConf Directory

In this section, you can make your TrueConf Server instance available for integration with TrueConf Directory.

To do it, click on the Activate button. To disable integration, click on the Deactivate button.

/server/media/tcd_activate/en.png

In the large box below the table, the secret key will be generated.

/server/media/tcd_key/en.png

Click on the corresponding button to copy the key. To connect the server to TrueConf Directory, use the key as it is shown in our blog post.