TrueConf Server Administrator Guide

  1. Server Side
    1. System Requirements
    2. Installation
    3. Registration
    4. Offline registration
    5. Administering
    6. Logging In and Logging Out
    7. Server status
    8. Server's log files
    9. Change the server language
  2. Client Side
    1. TrueConf Client
    2. Recommended configuration for TrueConf Server client terminal
    3. Where can I find client applications
    4. Client Application Connection
    5. Connection using auto discovering
    6. Manual configuration
  3. Configuring Server
    1. "Dashboard" Group of Settings
      1. "Summary" Section
      2. "Settings" Section
    2. "Network" Group of Settings
      1. "Network settings" Section
      2. "SMTP" Section
      3. "SIP Gateway" Section
        1. SIP-terminal calling format from TrueConf Client
        2. Invitation of TrueConf customer to the conference that is held on the SIP server
        3. Invitation of the SIP terminal to the conference that is held on the TrueConf Server
        4. Connection using CID (Conference ID)
        5. Invitation to the conference from TrueConf Client
        6. Connecting to an IP camera in a video conference
        7. Problems and Solutions
      4. "H.323 Gateway" Section
        1. How Can a TrueConf User Make a Call to an H.323 Endpoint
        2. How can a TrueConf User Invite a Polycom User to a Group Conference
        3. Connection using CID (Conference ID)
        4. Invitation to the conference from TrueConf Client
        5. How Can an H.323 Endpoint User Make a Call to a TrueConf User
      5. "Federation" Section
    3. "Web" Group of Settings
      1. "Settings" Section
      2. "Web Security" Section
      3. "HTTPS" Section
    4. "Users" Group of Settings
      1. "User accounts" Section
      2. "Groups" Section
      3. "Aliases" Section
      4. "User storage" Section
        1. Registry Mode
        2. LDAP Mode
    5. "Group Conferences" Group of Section
      1. Symmetric Group conference (Symmetric)
      2. Asymmetric conference (Asymmetric)
      3. Role based conference (Role based)
    6. "API"
      1. "OAuth2" Section
    7. "File Storage" Section
    8. "Recordings" Section
    9. "Endpoints" Section
      1. Sound capture and playback information
      2. Video capture device information
      3. DirectX information
      4. DirectX features description
      5. Connection information
      6. Network Test information
      7. Last conference information
      8. System information
      9. Events leading to the updating of information about the Endpoint
      10. Information shown in manager program is corrupted or couldn't be saved
    10. "Manage add-ons" Section

Server Side

Consists of two components:

  • TrueConf Server;
  • TrueConf Manager.
TrueConf Server

This component is a software video server. It gets installed as Windows operating system service and provides:

  • Client authentication and authorization;
  • Client connection, including connection through NAT’s and proxy servers;
  • Media stream retranslation when direct stream translation is not possible;
  • Communication between remote servers connected to the option "Federation";
  • Storing the call history.
TrueConf Web Manager

This component is dedicated to server component configuring.

TrueConf Manager provides:

  • Server registration, start , stop and state monitoring;
  • Server log viewing;
  • Server IP address and port set-up;
  • Registration of new users, activation and deactivation;
  • Revision of support information;
  • Group conferencing of different modes.

System Requirements for TrueConf Server

 Recommended configurationAdvanced configuration
ProcessorIntel Core i5-2320 @ 3.00GHz
Intel Xeon E3-1220 @ 3.10GHz
Intel Core i7-3770 @ 3.40GHz+
Intel Xeon E5-1620 v3 @ 3.50GHz+

50 WebRTC users

Recording a conference on server

 

100 SIP/H.323 non-transmitting connections
or
up to 1 conference with SIP/H.323 and with 3 broadcasting SIP/H.323 connections

50 WebRTC users

Recording a conference on server

RTSP/CDN Streaming

100 SIP/H.323 non-transmitting connections
or
up to 1 conference with SIP/H.323 and 8 broadcasting SIP/H.323 connections
or
up to 2 conferences with SIP/H.323 and 3 broadcasting SIP/H.323 connections
or
up to 4 conferences with SIP/H.323 and 1 broadcasting SIP/H.323 connection

Operating systemDedicated or virtual Microsoft Windows Server 2008/2012 with latest updates
RAM4 GB16 GB
Hard drive20 GB of free space
NetworkEthernet 1 Gbit/s.
Ports
  • Port 80 (specified during the installation of the server) is used by TrueConf Web Manager.

    *If this port is closed, the Slide Show feature won't be available.

  • Port 4307 (may be changed in TrueConf Web Manager) is used to exchange media data with client applications.
IPA static IP address is required for the server to work properly

Installation

TrueConf Server is shipped as a software installation package that contains the server side and client applications for popular platforms.

After the installation package is downloaded, launch it to begin the installation. The installation process will take less than a minute.

Note: TrueConf Web Manager port is determined during the server installation. By default, port 80 is selected. If it is taken, 8888 is selected. If it is also taken, the user selects the port in the installation dialog window (if the port is not 80, then it is visible in the browser address bar after the colon in the hostname http://localhost:8080).

Your browser will automatically open TrueConf Web Manager (Web interface for configuring the server) after installation.

Note: If you are installing server behind the firewall, then in order to complete the registration you should open port 4310 access from inside to internet.

How to change port for TrueConf Server Web Manager tool without having to re-install the server

To do this, go to the servers directory (C:\Program Files (x86)\TrueConf Server\httpconf\conf). In the conf folder open file listen.conf with a text editing app of your choice and change the port number in "Listen (port number)" parameter and save changes. This way you can change the port without re-installing your TrueConf Server.

Registration

After the installation of your web browser will automatically start server setup interface.

Register the server. To activate the server you have to get a registration key. Click on “Get FREE Key”:

Get free key

Click to open a page with application to TrueConf Server Free. Carefully fill all the fields and click on “Get a Registration Key”:

Get registration key

A registration key will be sent to the email address that you provided:

Sent email

Note: The key should be delivered in 15 minutes maximum. If this did not happen, request a key via live chat, or check the SPAM folder in your email client.

Return to the page of TrueConf Server settings and enter the registration key you have just received by e-mail.

Press “Register” to continue:

Registration key

After the server has been successfully registered, on top of the activation window of web-configurator a special sign will appear:

Status server

Offline registration

Note: Offline registration is not available for TrueConf Server Free. In case you need to work with the server in LAN, without connection to the Internet we may provide trial versions of TrueConf Server with full functionality during the trial period.

To register offline on a computer without an Internet connection, you will need a device connected to the Internet to obtain a registration key. On that device, go to https://trueconf.com/server/trial/ and follow the instruction from the "1.3.Registration" section.


Once you receive an e-mail with the test key, enter it in the field "Registration Key" in the Web manager on the computer with the running server and without an Internet connection, and click on "Registration":

In the registration window a new button will appear, "Create registration file". Clicking on it will generate a file that you will need to send:

Create registration file

Offlinereg.vrg file will be automatically saved in the default "Downloads" folder of the browser. Transfer this file using a flashdrive to a PC connected to the Internet and send at support@trueconf.com. In return, you will get the file you will need to transfer to your PC with the server you are registering offline.

* If downloading files option is disabled in your browser, you will not be able to download the offline registration file. Enable downloading option in your browser, then press again "Create registration file".

Note: always wait for a response to a request you have sent and do not restart the offline registration. If you restart the offline registration, the file sent for the previous request would not work aand you will have to do the process again to register.

Click on "Select file" on your computer and select the file offline.reg. Then click "Continue":

Continue oflline registration

When offline registration is successfully finished, the Web manager will notify that the server is registered.

Administering the Server

Server can be administered from any computer in the same local network where it is installed. The access is limited to the following ranges of IP addresses: 10.*, 192.168.*, 172.16-172.31, 127.

At this point the installer does not open a port in the firewall for TrueConf Web Manager. If the administrator wants to administer the server from a remote machine, he/she needs to make sure that the server firewall allows connecting on the port, on which TrueConf Web Manager is launched.

TrueConf Web Manager port is determined during the server installation. By default, port 80 is selected. If it is taken, 8888 is selected. If it is also taken, the user selects the port in the installation dialog window (if the port is not 80, then it is visible in the browser address bar after the colon in the hostname http://localhost:8080).

To access TrueConf Web Manager from the machine on which the server was installed you will not need any password (the host in the browser - localhost or 127.0.0.1).

Remote access requires authorization with the accounts of the Windows users from the group "TrueConf Server Admin". When the server is installed the user account is added to this group.

To give another user access to TrueConf Web Manager, the administrator must add the user account to the "TrueConf Server Admin" group.

 

Log in and Log out from the System

Logging in to the web interface of TrueConf Server is carried out automatically after registration and entering the registration key (see section 1.3. Registration).

To log out from the system (e.g. in order to log in using another key) click the Registration button in the Summary tab:

Register

Enter another key:

New registration key

If the key is valid you will log out from the system.

If you cannot log in to the server when entering the old key on other computer and the message “Registration key is incorrect. Check that code is valid. If you don't have a key you can get it” is displayed in the Web Manager tool, this means that your key is “bound” to the hardware on the machine where the server was installed:

Key is incorrect

If you want to switch off such a bond, please contact our managers: 1-347-878-3263.

Server status

Server status is shown in the "Server status" field in green (if the server is working) or in red (if it has stopped) in top right corner of the web management tool window:

Status server

What to do if server is not running?

In this case the red massage “Stopped” will be displayed in the “Server status” line:

Status stop

Possible reason № 1: You have no license, or the license is expired.

Workaround: contact your reseller or distributor.

Possible reason № 2: Some server files are missing or have been damaged.

Workaround: reinstall TrueConf Server.

Server's log files

If there are some problems during video conferences, you can collect logs on your PC and sent them to TrueConf Support Team. For this purpose, click View Log button in the Web Manager tool’s Settings tab:

View log

Save the report on your PC:

Save report

Send this report to our Support Team via e-mail: support@trueconf.com or contact us by phone: 1-347-878-3263.

Change the server language

You can change the language of the program directly from the Web management tool. To do this, click on "System". From the drop-down menu select the appropriate language:

Language

Client Side

Consists of:

  • TrueConf Client.

Note: See TrueConf Client application user guide to learn how to install and configure TrueConf Client application.

TrueConf Client

This is a client application. It is installed on the users' computers and allows making and receiving of video calls.

TrueConf Client provides:

  • User authentication in the TrueConf Server system;
  • Possibility to make video calls or create and participate in various group video conferences;
  • Set up of video and audio input and output;
  • Exchange of text messages;
  • White board tool for 1- on -1 conferences;
  • Slide show tool for displaying of graphic images in 1-on-1 and group conferences;
  • Screen sharing for transmission of your desktop screen to one or more participants;
  • File transfer;
  • User address book support and management;
  • Call list management;
  • Self view display in conferences;
  • Support of video formats: SD (320х180), HQ (640х360), HD (1280х720). In 1-on-1 video conferences is supported FHD video format (1920х1080);
  • Video and/or audio mute feature;
  • TCP and UDP transport.

Note: You can find information on how to connect client application to server in the "Client Application Connection" section of this document

  • Intel or AMD Processor with 2 GHz or higher clock speed;
  • 512 MB of RAM and 100 MB free hard disc space;
  • Windows Vista/7 SP1/8/8.1/10 operating system;
  • 256 kbps network connection in both directions;
  • Webcam;
  • Full-duplex sound card;
  • Headset (in order to avoid echo).

Where can I find client applications

For the users to start video conferencing, the link to the guest page must be distributed among them. On this page they can download client application for all operating systems.

Guest page is available at: http://localhost/guest (link may be different ac-cording to the settings of the server). For example, if the port 8888 was cho-sen during the installation, the guest page will be available at http://localhost:8888/guest).

You can find the link to the guest page in the Web/Settings Tab on the server settings page.

On the guest page the user can download client applications for Windows, OS X, Linux, Android, and iOS:

Language

Client Application Connection

You can connect the client application to your server either manually or automatically.

Connection using auto discovering

The client software of TrueConf includes a function of automatic search for the local server TrueConf Server (auto-discover). It is possible to install the client application without any information about your local TrueConf Server. In this case all information about the server will be detected automatically by using DNS. To do this you need to specify the address of the server in users primary DNS (primary DNS suffix).

You need to create SRV record in the domain for vcs2.tcp service and specify the TrueConf Server address and port.

The following example shows how to do this using DNS utility in Microsoft Windows 2012 Server:

  1. Navigate to root of the desired domain
  2. Choose «Other New Records…» in a right-click menu.
  3. Choose type «Service Location».
  4. Set the following parameters

In this example server has address videoserver.your.domain.com and port 4307. Please note that protocol name (tcp) does not contain underscores.

Manual configuration

Open TrueConf Web Manager home page on client computer.

Download client application for your system.

Share links for downloading client applications for desired platforms.

Launch the file on the user's computer and follow system's instructions.

Configuring Server

"Dashboard" Group of Settings

"Summary" Section

This page contains details on the license, registered contact person and available extensions used by the server. You can re-register your server here or proceed to purchasing new licenses for your server. In case of troubles with the registration of the server administrator may contact TrueConf technical support using the contact information that is displayed in case of an error.

About

If the server is connected to the Internet, administrator will get notifications about server updates. Notification sign will appear in the left menu in TrueConf Web Manager by the "Summary" section. On top of the page a message will be displayed with the link to download new version. After an update the sign and the notification will disappear.

If connection to the registration server is lost, your server will be shut down in 12 hours. The scheduled time of shutdown will be displayed in the tab "Summary".

"Settings" Section

Settings

  1. 1. Server working directory for saving log files.
  2. 2. Enable detailed logging.
  3. 3. Server usage statistics.
  4. 4. Server usage report.
  5. 5. Create server settings backup copy.
  6. 6. Restore configuration from en existing Settings file.
  7. 7. Client application download links (for connection to the server).
  8. 8. This code is used to create session keys for server user authorization. To generate a key, click "Generate a new key".
  9. 9. These​ settings​ ​are​ used to create session keys for transparent guest and user ​authentication where user does not need to enter username and password. This ​could be useful for integration ​purposes. To change the key, click “Generate a new key” or enter it manually into the corresponding field. To apply new keys, save ​settings and restart the server.
  10. 10. Limit the maximum outgoing bitrate.
  11. 11. Limit the frames per second on the display.
  12. 12. Limit the frame size in pixels.
  13. 13. Display statuses during the conference.
  14. 14. Save application settings.


Configuration

A backup copy of the TrueConf Server settings allows you to save the basic settings of your server: users, groups, scheduled conferences, network settings. This capability is useful when re-configuring the server, e.g. when you have reinstalled your operating system. Backup copy does not save files from the working directory as well as recordings.

When restoring settings from a backup created on the earlier version of the server, you need to re-launch the installation of the current server version upon completion of restoring. It is necessary for applying the settings to the new version of the server.

If server does not run after restoring backup settings, check the network settings: the current IP addresses of the server might not match with the previous IP addresses of TrueConf Server, and you will need to configure the IP addresses again.

If you are restoring the settings on an OS other than the OS you ran when you were making backup of those settings, you will need to re-register the server to start it.

If you are installing a new version of the server over the old one, all settings are retained, you don't have to apply backup settings after the installation of a new version of the server.

If you are installing the older version over the new one or restoring the settings created on a newer version of the server, the stable operation of the server is not guaranteed.


TrueConf Client/TrueConf macOS Settings

By clicking the name of the application (TrueConf Client Client или TrueConf macOS) , you will open the settings tab:

If the current version of the client application is earlier than the said version, the work of the client application will be stopped and it will be updated in a mandatory manner.

If the application version is less than the indicated version, the user will be asked to upgrade his client application and given the link to the appro-priate version.

"Network"

"Network settings" Section

Internal addresses and ports that will be used for clients to contact this server. By default the server uses all IP addresses of machine on default TrueConf Server port 4307. When default settings are on, current connections are displayed in this column.

 

External addresses are the ports and IP addresses or DNS names, which help client applications to connect to the server. If the server uses NAT or has DNS names, external addresses can differ from the internal ones.

 

DNS names can be used for host identification. When using addresses and/or ports translation (NAT), translated address and port must be en-tered into the relevant fields.

 

If you plan to transfer server to another IP address, you need to enter the future IP address and rele-vant port into the right column. This will help users to store the future IP address during the next session. When the server is switched to the new address, users will switch to it automatically.

Network settings

  1. 1. To specify non-default external addresses, check "Specify" checkbox
  2. 2. To change internal addresses, uncheck "Listen on all IP addresses" checkbox
  3. 3. To add a new internal or external IP address. Use the button "Add" and enter the necessary data in the "Host" and "Port" fields
  4. 4. Teturn to previous settings
  5. 5. To save the changes
"SMTP" Section

Mail server is used to send notifications to the users about missed calls and to the TrueConf system administrators about the server operation:

SMTP

  1. 1. IP address or SMTP server host name, used by TrueConf Server for sending e-mails
  2. 2. Sending e-mail notification to the administrator in case of server reload caused by internal problems
  3. 3. Enter the email address which will be used to automatically send emails to the users.
  4. 4. Successfully connected status in case of connection to SMTP server, invalid server if the connection can not be established (use another outgoing e-mail server in this case).
  5. 5. Checking SMTP server connection status
  6. 6. Option for sending e-mails: without authorization, with a password, with NTLM authorization (without entering the password)
  7. 7. Sending e-mail notifications to the users with missed calls
  8. 8. Restoring Default e-mail templates
  9. 9. Editable example of subject and body of the letter about the missed call to unregistered users
  10. 10. Editable example of subject and body of the letter about the missed call to registered users
  11. 11. Activation of an automatic user notification with the upcoming participation in a video conference
  12. 12. Ready-to-edit e-mail template with an invitation to the Group conference


Note: When "simple password" authentication type is selected, new fields will appear in section "Outgoing Mail Server" - "Username" and "Password". Specify your email login and password. If SMTP is configured in the local network, you don't need to fill in these fields.

You also need to specify the email details in the fields "Host" and "Port". E.g., if you are using a gmail account, you have to enter "smtp.gmail.com" in the field "Host" and the port value in the "Port" field.

If the external mail server demands using SSL (a secure authorization protocol) when authorizing, check the box "Use ssl".

Note: IP address 127.0.0.1 means that you are using SMTP server on the same computer as TrueConf Server. In this case you will be prompted to verify SMTP server installation on this computer.

In case of a missed call to a registered or unregistered user of TrueConf Server this event will be logged on the server and user will be notified by predefined e-mail.

Note: Server logs time of the call, name of the caller, username. This information is substituted by the server in the template using tags:

  • %recipient_display_name – name;
  • %caller_display_name - display name of the caller;
  • %caller_call_id - id of the calle;
  • %missed_call_time - time of the call.
"SIP Gateway" Section

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. Please note that TrueConf Server Free version supports only one active connection via gateway, while the number of rules created using these settings is unlimited.

SIP

Network settings

This table contains address gateway uses to listen for incoming SIP connections. By default the list is prefilled with IP-addresses of 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 Business 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 Business connection. Skype for Business template has some preselected features required for Skype for Business interoperability pre-selected, e.g. port, protocol, used video codec and registration mode.


New Rule Form

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.


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.

Please note that each active gateway connection reserves one SIP/H.323 connection from your server’s license.


ICE mode (Interactive Connectivity Establishment) makes TrueConf Server gateway available behind NAT.


SRTP mode is used to encrypt media data sent in this direction. For some SIP devices encryption is mandatory e.g. for Skype for Business servers.


BFCP support 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.

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


SIP device for which the rule is created can take special roles. There are two roles, and each of them can be applied only to one SIP device in the list of the rules.

  • Default SIP Proxy – this role allows users to avoid to enter 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 turn SIP device into 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 SIP device. 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 default VoIP server can only be applied to one SIP or H.323 rule for any connections.


Skype for Business Integration Configuration

This integration is designed to work with Skype for Business 2015 or Lync 2013 dedicated servers and cannot be used for its cloud versions.

  • Create a new account on Skype for Business server for TrueConf Server gateway.
  • Use Skype for Business template to create a new rule for SIP connections. Enter username and password of this freshly created account in the appropriate fields.
  • Enter Skype for Business server IP address or domain name in the Host field.
  • Check Default SIP Proxy checkbox.
  • Save the rule and check if the connection status has changed to successful in the table for rules.

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


To call TrueConf users from Skype for Business client application, send the following message to the user created for TrueConf Server authentication (on step 1): /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 call Skype for Business 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 Business users and various SIP / H.323 devices or RTSP IP-cameras.


Global SIP Settings Section

Global settings

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.

  • 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).
SIP-terminal calling format from TrueConf Client

One of the formats given below can be used:

  • #sip:Call_ID@Server_name, where Call_ID is SIP user, Server_name is a host name or IP address of the SIP server;
  • #sip:Call_ID, call is directed to the Call_ID user on the server, which is indicated in the VoIP Server/SIP Proxy of the SIP Gateway tab;
  • #sip:@IP, call to the IP address of the SIP terminal.
  • #sip:@hostname, call to the DNS name of the SIP terminal.
Call routingValue
Via VoIP Calls are redirected to phone numbers
(#tel:89261112233)
Via SIP Proxy Calls are redirected to user’s Call_ID (#sip:james78)
Invitation of TrueConf customer to the conference that is held on the SIP server.
  • login to the client application TrueConf Client;
  • organize conference on the SIP server (MCU), invite terminals to the conference;
  • add to the conference TrueConf ID you used to login to the client application TrueConf Client, as TrueConf_ID@IP, where IP – gateway address of the TrueConf Server, which is indicated in the SIP Gateway tab:

Invitation of the SIP terminal to the conference that is held on the TrueConf Server.

There are two ways ot inviting a SIP endpoint into a video conference - from Address book of TrueConf Client application or from TrueConf Web Manager.

1. From Address Book in TrueConf Client application. Do the following:

  • add SIP endpoint to the Address book in the following format: #sip:user@host, where "host" is IP address or a domain name;
  • call it by a double-click on the name of the subscriber:

2. From TrueConf Web Manager. to do this:

  • create and plan a group video conference, using the tab "Group conferences";
  • enter SIP endpoint as a participant of the conference. In the indicated day all the participamts will be invited to the conference:

  • SIP ID

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

Proceed to Group Conferences tab and create a group conference. Take note of your CID value (e.g. \c\e22a39ba2a).

To connect to the conference from the endpoint registered on TrueConf Server, enter CID@Server into the endpoint address string, where Server is TrueConf gateway address. Please note that when calling from an external endpoint, you need to replace \c\ with 00 (two zeroes). In our case, you need to enter 00e22a39ba2a@Server, where Server is TrueConf gateway address.

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

  • CID@Server. Please note that you need to replace \c\ with 00 (two zeroes), e.g. 00e22a39ba2a@192.168.66.112.
  • CID@Server:Port;transport=Protocol. You can indicate non-standard port for SIP connections and choose a protocol (TCP or UDP), e.g. 00e22a39ba2a@192.168.66.112:5061;transport=TCP.

Note: to learn how to connect to the conference from a SIP endpoint, proceed to the Help section on the conference webpage.

Invitation to the conference from TrueConf Client
  • Add to the TrueConf Client address book terminals that you want you want to invite to the TrueConf conference in the format described in the paragraph 3.2.3.1;
  • Organize conference in the TrueConf Server configuration wizard or client application TrueConf Client;
  • Invite terminals to the conference by a double click on the terminal name in the TrueConf Client address book.
Connecting to an IP camera in a video conference

You can connect an IP camera to a conference during a point-to-point call or a group conference, if the given camera supports RTSP protocol.


Connecting from TrueConf Client application:

  • For a video call: paste #rtsp_url in the address bar and click on «Call». rtsp_url – is an individual RTSP address of the camera (it's format depends on the vendor, model and camera's mode). For example, the cameras by Axis rtsp://IP/axis-media/media.amp. When pasting, replace the IP with the real IP address of the camera, and symbols '/' with '%2f'. The final version may look like this: #rtsp:%2f%2f217.17.220.110%2faxis-media%2fmedia.amp:

  • Invitation to a group conference: add the IP address of the camera to the address book beforehand. Choose the group video conference and invite the participants. If the event is already taking place, go to the Address book, choose the IP camera from the contact list and click on "Invite to conference":

Connecting from Web-Manager (for the administrator):

  • create a Group Conference - public or private in Group conferences tab;
  • type the IP camera address in Add by ID field (ID field is located in Add participants tab, when following the Participants link on Conference Creation), click Add and Apply;
  • run the video conference:

RTSP

Troubleshooting

SIP-terminals do not connect with TrueConf Server

DescriptionPossible reasonSolution of the problem
SIP terminals cannot connect with TrueConf Server. Invalid IP address in the TrueConf Server configurations.

Check rightness and correspondence of the data in the SIP Gateway tab of the configuration wizard:

  • Address: an IP address of the network interface used for TrueConf gateway;
  • Server: IP of the host interface, which is used for VoIP/SIP server.
TrueConf Server is offline or has intermediate status.Run TrueConf Server by clicking System/Start.
Absent or incorrect parameters of TrueConf Sever on the SIP terminal.Indicate valid IP address and TrueConf Server port in the parameter window of the SIP-terminal.
Invalid input format for conference parameters.Please refer to SIP endpoint user’s guide to check input format for conference parameters.
No network connection.Check network connection on the PC with SIP terminal (if SIP terminal is installed on the PC). To do this you can use "ping" command with IP address of the PC where TrueConf Server is installed.
There is no video and audio in the conference between TrueConf Server and SIP terminal.Incorrect codecs negotiation.Make sure that SIP terminal supports one of audio codecs: G.711 (alaw/ ulaw), G.728; and video codecs: H.264, H.263.
"H.323 Gateway" Section

This control panel section allows you to configure gateway parameters for H.323 connections. TrueConf Server Free allows only one active gateway connection for H.323/SIP devices. The number of rules for H.323 connections created using this section of control panel is unlimited.


H.323 interoperability is usually used to call legacy video conferencing endpoints. Additionally, TrueConf Server built-in gateway provides integration with MCU, Gatekeeper and PBX, which might be useful for addressing devices and endpoints registered on these equipment via H323-ID or E.164 notation without indicating the endpoint’s IP address.

H.323

Network Configuration Section

There is a list of addresses gateway listens for incoming H.323 connections. By default, it is filled with operating system IP addresses. You can edit this list by unchecking "Use all IP addresses" checkbox. The list of ports used for H.323 connections is available in our blog.


Rules for H.323 Connections Section

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

H.323

Name field value is used only in the rules table to distinguish one rule from another. “Host” and “Port” fields are more important and 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.


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 enable registration support using the corresponding drop-down menu. Please note that each active gateway connection reserves one SIP / H.323 connection from the server’s license.


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.


H.235 encryption is designed to enable 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.


H.239 content transfer support allows you 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.


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


H.323 device for which the rule is created can take special roles. There are two roles, and each of them can be applied only to one direction in the list of the rules.

  • 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 default VoIP server role can only be applied to a single SIP or H.323 rule, not both.


Global H.323 Settings Section

Global settings H.323

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 user ID or conference ID (CID) which will receive all incoming calls over H.323 protocol in cases where destination user ID isn’t specified.

How to Call H.323 Devices from TrueConf Applications

This section describes call strings that are interpreted by TrueConf Server as a call to H.323 device. They can be used in different ways, e.g. you can add them to the address book, just dial or add to the list of participants of the scheduled conference on the server.

  • #h323:@Endpoint, where Endpoint is the IP address of the H.323 device.
  • #h323:H323ID@Endpoint, where H323ID is the ID of user or device registered on H.323 device with IP address specified in Endpoint parameter.
  • #h323:\e\E164@Endpoint, where E164 is a number in E.164 format of a user or a device registered on H.323 device with IP address specified in Endpoint parameter.

The following call strings can be used only if default H.323 gateway role was assigned:

  • #h323:H323ID, where H323ID is the ID of the H.323 device.
  • #h323:\e\E164, where E164 is phone number in E.164 format of a H.323 device.
How to Сall 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.
  • 00CID@Server, where first two characters are zeroes, CID is ID of the conference on TrueConf Server and Server is TrueConf Server IP address.

For TrueConf Server versions older than 4.3.9 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 to escape 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 user perspective, H.323 device registered on the server does not differ from any other contact: you can see its status, call it from the address book or invite to the conference without using #h323 special prefix. Similarly, calls using H323ID from a registered H.323 device interface will be interpreted by the server as a call to specific TrueConf Server user ID equal to entered H323ID.


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 Can an H.323 Endpoint User Make a Call to a TrueConf User?

To call a TrueConf Server user, you only need to specify the name of a TrueConf user in the field H323ID or E.164 (if the name / alias consists of numbers).

"Federation" Section

Federation

  1. 1. Connection with all but blacklist servers.
  2. 2. Federation is off – no connection with other servers.
  3. 3. Connection with whitelist servers only.
  4. 4. Adding servers to the blacklist. Click the Add button to open a window adding there the server address you do not want to get calls and messages from. Click Save to save the changes.
  5. 5. Adding servers to thewhitelist. You can contact users of whitelist servers with all video conference modes. On adding the server address click Save.
  6. 6. Apply all changes.


Federation between servers

Federation allows subscribers of different TrueConf Server to make video calls, conduct group conferences and use collaboration tools. The server which has a "Federation" option enabled provides media streaming between remote servers that support this feature it too. The number of servers involved in Federation is unlimited. Group video conferences will be conducted with regard to the limitations specified in the license of the server, initiating the connection.

Video calls and group conferences during Federation are held on the same principle as within one TrueConf Server. No additional server adjustments should be done when using Federation feature. Still, the following conditions are to be observed: you need to have license for TrueConf Server with Federation feature for all servers that participate in Federation, possibility for all servers and subscribers to connect to your server during Federation.

The server should be available to other servers by its name, indicated at registration. The server can be registered on the existing DNS name, as well as be specified by the actual server address with the help of the SRV records DNS. To read more please see section "Connection using auto discovering".

Note: In case your server does not support Federation, following the Federation tab notification will be displayed: Federation mode is not available for yourserver license. To Activate this feature, contact our managers.

 

"Web" Group of Settings

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

"Settings" Section

Web settings

  1. 1. TrueConf Server address used to build guest page links and scheduled web conference links.
  2. 2. A link to the guest page which contains instructions on how to connect new users to TrueConf Server.
  3. 3. Server administrator contact details which are published on the guest page and web conference pages.
  4. 4. Links to client application for Windows and macOS which are displayed on the guest page.
  5. 5. Custom logo upload form for the guest page.

"Web Security" Section

Web security

  1. 1. Access to server administration for local group members of ‘TrueConf Server Administrators’ group.
  2. 2. Access to server administration for any Window user, not only for local group members.
  3. 3. By checking this field you limit the access to controlling your server.
  4. 4. Following any links ubnet editing option will open in a window.
  5. 5. To ensure that TrueConf Server works with other products through the Internet in federation, the network administrator should connect to Directory. To secure the connection he must use secret security key. After it is generated, click on "Apply".


Adding subnetwork

Add the address in Subnet Address field (admissible symbols are – numbers and a dot, admissible format – 4 octets in decimal representation without initial noughts from 0 to 255, separated by dots, eg. 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.

"HTTPS" Section

In this section of the Web Manager Tool you can configure a safe data transfer channel between browser and web server via HTTPS protocol and also between browser and TrueConf Server via WSS protocol.

НTTPS

  1. 1. This section contains the following settings:
      choosing one of HTTPS modes;
    • choosing a port which will be used for connection via HTTPS protocol;
    • testing the chosen settings;
    • choosing a port which will be used for connection via HTTPS protocol;
    • applying the chosen settings.
  2. 2. Choose one of three modes: turn of HTTPS - this mode turns off the HTTPS protocol; use self-signed certificate - this mode uses the certificate obtained from the Web Manager Tool; use downloaded certificate - this mode uses a certificate uploaded by the administrator of TrueConf Server.
  3. 3. Tutorial "How to Configure HTTPS in TrueConf Server"
  4. 4. Set TCP port, which responds to the web server for operation via HTTPS protocol. Port value is 443 by default. Only digits are available for entering to this field.
  5. 5. Click this button to verify HTTPS configuration data without restarting the web server. This action does not change the configuration file of the Apache web server. Verification is perfomed by the steps specified in the Verification and adoption of settings block.
  6. 6. Generate a new sertificate. The Self-Signed Certificate section has such an appearance only if this certificate type has not been issued before. Should certificate has been already issued, this section would contain the main data of root certificate and certificate which will be used by the web server and TCS (refer to the Self-Signed Certificate block description).
  7. 7. To download certificate files and key you should choose them and click the Download button. The Downloaded certificate section has such an appearance only if this certificate type has not been issued before. Should certificate has been already downloaded, this section would contain the main certificate data (refer to the Downloaded Certificate block description).


The existence of safe connection channel between browser and server is essential for media devices capture by means of browser using WebRTC technology for Google Chrome browser starting from version 47.

To set a safe connection, the server administrator needs certificate file in X.509 format and corresponding private key file.


There are two types of certificates available for use in the Web Manager tool:

  • Self-Signed;
  • Fully-Featured.
 

Self-Signed Certificate

Capabilities:
  • Generated by the Web Manager tool, issues for 365 days.
  • Can be extended for an unlimited period.
  • Can run WebRTC testing without a fully-featured certificate.
Details:
  • Manual installation of root certificate is required for all client devices where HTTPS and WSS will be used.
  • The process of root certificate installation is different for Chrome and Firefox.
 

Fully-Featured Certificate

This type of certificate should be bought in the Certification Centre (CC). Fully-featured certificate doesn’t require any additional operations with client devices, since browser trusts the publisher who signed it.


Settings Revision and Adoption

Web server uses HTTPS settings at launch. Wrong port and certificate data can cause server error and administrator will lose access to the Web Manager tool. Therefore, it is highly important to make thorough check of the preset parameters.

The best way to check the parameters is to launch a web server copy using specified HTTPS settings with further analysis of launch results (currently the installation wizard works in this way when choosing a web server port). In the Web Manager tool project PHP operates as an Apache module, which doesn’t allow launching a web server copy from PHP script as it’s not possible to launch a new control process from an already existing one. Therefore, at this stage it is necessary to check the entered data according the following steps:

  • Check availability of a specified HTTPS port for using it with Apache server.
  • Check the file specified as certificate for compliance with X.509 format by means of openssl library.
  • Check the file specified as private key by means of openssl library.
  • Check the private key and certificate compliance by means of openssl library.

Self-Signed Certificate

If the certificate has already been issued, this section will contain basic parameters of root certificate and certificate which will be used by the web server and TCS:


Self-signed certificate

Administrator can download a root certificate file for sharing among client devices via the link Download ca.crt.

The Create new SSL certificate button allows to reissue a server certificate signed by the same root certificate if expiration date is still valid. Otherwise, the certificate will be signed by a new root certificate. This option is necessary to extend the validity period for another 365 days or to update your company information in the certificate.


Downloaded Certificate

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

Certificate format, key format and key correspondence to certificate are being checked during download. Should at least one check fail, certificate and key files would not be not saved.

"Users" Group of Settings

"User accounts" Section

In User Accounts section you can add and manage users.

* The maximum number of accounts in the free version of TrueConf Server Free is 12.

Add user

  1. 1. Adding new user. Clicking on this button will open a form for filling in the information about the user.
  2. 2. Refreshing information about the user.
  3. 3. Search to users in Address book. To do this, enter subscriber's data in the filed Search: enter name or TrueConf ID. When "Online" checkbox is selected, the search will be conducted among the users who are currently online.
  4. 4. List of users, registered on the server. User status is indicated in colored, square shaped icons displayed to left of TrueConf ID. Green color – the user is online, red – the user is offline, yellow – the user is in the conference, yellow star - the user is owner in the conference. In order to change user information, click on the box with user’s information. To delete a user click the x icon; this appears after pointing to a username with a cursor.

Note: In LDAP mode user edit is not possible, edit users using your LDAP directory tools.

By clicking on any account name or TrueConf ID you will open an editing window:

Edit user

  1. 1. Can be Active or Passive. Passive users cannot connect with the server but their account will not be deleted. Clicking Disconnect button, the user being edited will be disconnected (from the network).
  2. 2. Mandatory field. It is used for authorization and calls. Full TrueConf ID contains this TrueConf Server registered server name.
  3. 3. User's password to log in to the client application.
  4. 4. E-mail for user notification.
  5. 5. This filed is required. If this field is left blank then it will be filled in automatically by joining the TrueConf ID.
  6. 6. This fileds are not required. Personal data and. The name of the organization where the user works.
  7. 7. E-mail for user notification.
  8. 8. User may belong to some group.
  9. 9. (Save) - click to save all changes to the user account. (Delete) - click to delete the user account. (Back) - Return to the previous page.
  10. 10. You can enter user's TrueConf ID in this box on the Server side in order to add him/her to your Address Book. You can also enter his/her name in the "Display Name" box.

"Groups" Section

In the Groups settings you can create user groups, rename, edit, and delete them, and also manage the list of users in each group and set up their Address Book. Enter the name of the group and click Create:

Groups

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

In "Groups" tab you can create, edit and delete groups, as well as add and remove users, manage address books. You can also allow or forbid the following:

  • Address book editing. By putting a checkmark in this box, the administrator will allow users to edit this groups: change display names of users, delete/add new members, and perform any other changes in the member's Address Book. If the box is not checked, users from this group will not be able to perform the aforementioned changes. In this case, all changes are carried out by the administrator in the Web Manager tool and affect all Address Books of users from this group.;
  • Making Calls;
  • Using collaboration tools;
  • Creating group conferences;
  • Operator Rights. Operator right enables a group participant to become a moderator of any conference he or she joins.
 

Menu "Group Name"

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":


Rename group name

In the opened window, in the field "All users" hover over the user you want to add to the selected group. Press "+" to relocate the user to the left list. In such a manner you can add all necessary users to the group. After that, press "Save" to save the changes:


Add new user

All selected users will be displayed on the group page:


Users in the group

To rename a group in the drop-down list "Groups" select the group you want to rename and press the button "Rename". A window will open:

In the field "Group" enter a new group name and press "Save" (or "Cancel" if want to exit the window).

 

Menu "Customize" - Address book

Administrator can manage address book by adding and deleting contacts, including subscribers that are not the users of the server.

When you click on "Settings", you will be directed to the page "Address book settings" of a specific group. There you can change all the necessary settings:

Status server

  1. 1. With this checkbox the users of a certain group will see all users of the server in their.
  2. 2. Group participants see only users of certain groups. When choosing this checkbox you need to select from dropdown menu the groups to include to the address book.
  3. 3. Group participants cannot see other users of the server.
  4. 4. Save all changes.

At the same time, users of a certain group can search for other users of the server and add them to their address book (if address book editing is enabled).

 

Address book for a group

In this menu you can add external contacts by entering TrueConf ID and Name of the user.

"Search by name of TrueConf ID" is used for searching for a user in Address book. When "Online" checkbox is selected, the search will be conducted among the users who are currently online.

"Aliases" Section

In this tab PSTN users can dial TrueConf user not by TrueConf ID, but with the help of an alias (extension). You can set an alias to a TrueConf user, that will be used to dial a person under the corresponding configuration of the ATE from our system.

Aliase

  1. 1. Alias is entered by a user into the corresponding field. It can contain letters and digits. The Alias can contain up to 32 symbols. Aliases are updated after server restart.
  2. 2. You can choose a person from a list of users or enter his/her TrueConf ID into the corresponding field. After the alias is created you can see an alias and TrueConf ID of a user. User name is not unique: one user can have several aliases.
  3. 3. By clicking this button, the chosen alias will appear in the field "Aliases".
  4. 4. To delete an alias from the list, tick the box on the left of his name and click on "Delete Selected".

"User storage" Section

* Unavailable in the free version of TrueConf Server Free

TrueConf Server allows two modes of data storage - Registry and LDAP. Their changeover can be done at any given moment by pressing the «Switch» button in the «User database» tab.

User storage

Registry Mode

In this data storage mode the server keeps user information on a local computer. It is possible to add and delete new users from the configuration table. If the storage mode on the server has been changed from the Registry Mode to LDAP then the already existing user records won’t be used any more.

 

User storage tab in the Registry Mode

ElementDescription
SwitchSwitching of the data storage modes
LDAP Mode

In this data storage mode the server takes advantage of the user information from the remote or local LDAP directory. LDAP settings comply with Microsoft Active Directory by default. You can manage the user information with the help of LDAP Directory standard management tools. For Active Directory the user rights can be defined depending on the Active Directory group to which a user belongs.

To activate this mode, put a checkmark in the "Turn LDAP mode on" box and click on the appeared button "LDAP Setup". LDAP settings form will open in Web Manager tool of the Server.

LDAP

  1. 1. Following this link you will enter the Help section. (LDAP tab description).
  2. 2. LDAP Server type.
  3. 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. 4. Automatic choice of the LDAP server.
  5. 5. Manual choice of the LDAP server.
  6. 6. In the automode 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.
  7. 7. LDAP server address and port.
  8. 8. Core LDAP context.
  9. 9. TrueConf Server authorization modes on the LDAP server.
  10. 10. Authorization parameters on the LDAP server.
  11. 11. 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.
  12. 12. For Active Directory in this field it’s possible to indicate LDAP - group of users, who can get authorized on the TrueConf Server. To choose a 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.
  13. 13. Additional LDAP parameters. Allow to adjust the parameters to other types of LDAP-servers.
  14. 14. 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".

Note: The users' passwords are not imported. After being imported the users’ accounts are marked as «inactive» (see description in the «User accounts» tab).

Directory of groups and users registered on the video-conferencing 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) of the created group. You can edit his/her attributes in the Edit user information window. In the LDAP mode this window allows to define rights for several LDAP groups. User attribute can be defined in the LDAP folder.

Note: On the server the <Not in group> is created by default.

"Group Conferences" Group of Section

This section allows you to manage group conferences.

* The maximum number of participants in a group conference of any type in the free version of TrueConf Server Free is 12.

Symmetric Group conference (Symmetric)
  • Can have up to 36 participants at the same time in the normal mode and up to 36 users in the UDP Multicast mode (number of users is limited by the TrueConf Server license;
  • All users can see and hear each other.

This conference type availability is limited by the TrueConf Server license

Asymmetric conference (Asymmetric)
  • Can have up to 36 participants at the same time;
  • One user is chosen to be the Host. He can see and hear everybody;
  • Other users can see and hear only the Host.

Conference type availability could be limited by TrueConf Server license.

Role based conference (Role based)
  • This conference type availability can be limited by the TrueConf Server license;
  • No more than 6 users can transmit video and audio to the others. They are called "broadcasters";
  • Other users can hear and see broadcasters. They can give their opinion. They can become "broadcasters" if the Host allows them.

This conference type availability can be limited by the TrueConf Server license

Note: When the conference is getting started the administrator chooses the user who will be the Host.
Other roles will be given by users in a conference. Look for more information in the client application User Manual

Group conference list

This tab allows administrator to create and manage group conferences.

Group conference list

  1. 1. Add group video conference.
  2. 2. Delete group video conference.
  3. 3. Start group video conference.
  4. 4. Edit group video conference.

Current version supports WebRTC broadcasting in Chrome, Opera and Mozilla Firefox browsers. The number of concurrent connections is limited by the chosen license capacity.

Create new group conference

Follow Group Conferences link to enter the menu with the list of Group Conferences. Click Create button to open the page with the choice of Conference Type - Internal or Public:

Private or public

Internal conference

Private conference

  1. 1. Conference Name Field. Eg. Marketing Department Meeting.
  2. 2. Following the link with the Conference mode (Role-based by Default) you will enter the Menu, where a choice of a conference type can be made – be it symmetric, asymmetric or role-based (see Conference mode section).
  3. 3. Owner (Conference owner) choice from the list of users field (see Owner section).
  4. 4. Conference ID that users can use to join the conference.
  5. 5. UDP Multicast allows to use local network resources more efficiently. In this mode video and audio streams are transmitted only in one UDP Multicast domain. Such domains can be set up in local area network (LAN) or VPN. In the internet UDP Multicast is not allowed by default.More availability can be limited by TrueConf Server license.

    When selecting UDP Multicast mode, the following features will become unavailable: connecting to the conference via external protocols (WebRTC, RTSP, SIP, H.323, etc), server-side recording and streaming.

  6. 6. The field to indicate Multicast/Broadcast IP address. By default it is 224.0.1.224:4000-6000.
  7. 7. In this field you can add user to a conference (see Participants section).
  8. 8. Schedule selection (see Schedule section).
  9. 9. Broadcasting check is off by default. Enabling the check in this field you allow the ability to display RTSP on WebRTC page.
  10. 10. Description menu item adds accompanying text to the scheduled Event (e.g. adding accompanying text to reports of participants or event schedule). The text will be displayed on the Home Page when external users are connected.
  11. 11. Press to setup streaming (see Streaming)

Server response time

If the server-receiver did not send the conference data acquisition notification the broadcast is interrupted.

Such a verification is necessary because RTSP broadcasting process is one-sided (broadcast data is sent only from TrueConf Server side to the server-receiver side). The verification is carried out by the protocol, which does not provide information to the sender (TrueConf Server) that the recipient (server-receiver) has received the broadcast data. As a result, a server-receiver must send the data acquisition report within the stated time independently.

 

Another advantage the option provides: in case the server-receiver shuts down and will not notify the TrueConf Server, TrueConf Server finds it out and stops spending resources on sending data where unnecessary.

 

Possible field values: 0 - data delivery verification is off. It is useful to turn off the verification when the server-receiver can not send the data acquisition report, proceeding with the data acquisition. In this case the broadcast can be interrupted by the verification at the most unsuitable moment. It is required to specify the verification process in advance while working with such kind of unstable servers. 0 > (greater than 0, e.g. - 60 seconds, time set by default) - verification is on within the stated time period. After this period of time in case of no conference data report returned from the server-receiver the broadcast is interrupted.


Conference mode Section

Following the link Symmetric conference, you enter the menu bar which contains choice of a Conference mode.

Choose a required number of Speakers (who are taking the Podium)from a drop-down list to hold a Role based conference. Maximum number of Speakers transmitting simultaneously is 6. Note that if you chose only 3 Speakers to transmit simultaneously when creating a conference, the number of Speakers can not be increased. That is why it is better to choose the proper number of simultaneous Speakers and click Save:

Conference mode

Maximun number of Role based conference participants depend on your licence. The total number of participants unlimited licence can be up to 250.

Owner Section

Following the Owner (Select) link menu, a list of server accounts will open. Choose a user to assign as a Conference Owner of the conference to be created:

Owner

Participants Section

The Participants section displays a number of participants you can invite to a conference. There is a limited number for each Conference Type. Clicking the number e.g. 0/25 you enter the menu where conference participants are chosen and invitations to them are sent. In field Invited Participants, enter the username or the name of the Group for a conference invitation to be sent. Then choose Participants, clicking "Select from the contact list":

Participant list

A list of Contacts displays on click. Pointing a Contact name with a mouse "+" icon will appear. Click the "+" icon to add users to a conference Participants. The added user will appear in the invite es list on the left side:

Select from the contact list

You can assign a selected user as a conference moderator. To do this, put the mouse cursor over the selected user and click on the star icon:

Moderator

When all the users are chosen, click Send Invitations, to deliver invitations for each user. Invitation will contain a link to the conference.

Click Apply to save changes.

Add by ID button opens a window with fields allowing to add a user by ID (in case the subscriber is not already in the Address Book):

Add new participants

You can also invite Participants using the button Add Guests. In the opened menu fill in the Name and E-mail fields, then click Add:

Add guests

Schedule Section

No Schedule is set by default in the Schedule section. Clicking the link, you can choose a Schedule Mode for the Conference Type in the opened menu:

  • Without schedule – for a conference started manually;
  • Nonrecurrent – for a conference started automatically one time. Choose start and end date and time of your video conference, as well as your time zone;
  • Every week – for a regular weekly conferences, started automatically. The day of a week, time and time zone are preset.

Schedule

When all the changes are made, save them clicking Save button.

 

Streaming Section

Click on "Turn on" (please note that it is not available when UDP Multicast is activated) to open streaming configuration window, where you can select a streaming configuration, change it or turn it off. If no configuration is set up, select "Add a new configuration" from "Streaming configuration: " drop-down list:


Add a new configuration

Streaming through CDNvideo cloud service

Click on "Аutomatic 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:


Streaming CDNVideo

  1. 1. Selected template for current streaming configuration.
  2. 2. If you already have a CDNvideo account, click on this link to enter your username and password.
  3. 3. Email address that will be used to create a new CDNvideo account. TrueConf Server administrator email is used by default.
  4. 4. By creating a CDNvideo account you agree with CDNvideo terms of use.
  5. 5. Return to streaming configurations list.
  6. 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.

To receive a widget code, choose streaming configuration through CDNvideo service on the conference edit page and save the changes. After that “HTML player code” link containing streaming widget code will become available:


HTML code

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:

Wowza Streaming

Wowza Streaming Engine

  1. 1. Configuration name displayed in "Streaming configuration" list on the conference edit page.
  2. 2. Address of the Wowza Streaming Engine.
  3. 3. Wowza Streaming Engine accepts connections on this port (e.g. 1935 or 1940).
  4. 4. You can find necessary information in Wowza Streaming Engine user’s guide.
  5. 5. Check "Authentication" to enter username and password to access Wowza Streaming Engine if required.
  6. 6. This section includes additional settings for current streaming configuration (see “Additional streaming configuration settings” in present user’s guide).


Wowza Streaming Cloud

  1. 1. Link to the instruction on how to setup streaming through Wowza Streaming Cloud in our blog.
  2. 2. Configuration name displayed in "Streaming configuration" list on the conference edit page.
  3. 3, 5 и 6. You can find necessary information in Wowza Streaming Cloud user’s guide.
  4. 4. Wowza Streaming Cloud accepts connections on this port (e.g. 1935 or 1940).
  5. 7. This section includes additional settings for current streaming configuration (see “Additional streaming configuration settings” in present user’s guide).


YouTube

  1. 1. Link to the instruction on how to setup streaming via YouTube.
  2. 2. Direct link to the conference stream required for the configuration of streaming via Youtube.
  3. 3. This section includes additional settings for current streaming configuration (see “Additional streaming configuration 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 for pick up. When using RTSP Pull, the platform itself collects the content from TrueConf Server.


Publish Manual Setting


  1. 1. Configuration name displayed in "Streaming configuration" list on the conference edit page.
  2. 2. The address which will be used to notify about available stream via RTSP ANNOUNCE protocol.
  3. 3. Check "Authentication" to enter username and password and gain access to Wowza Streaming Engine.
  4. 4. This section includes additional settings for current streaming configuration (see “Additional streaming configuration settings” in present user’s guide).


RTSP Pull Manual Settings

  1. 1. Configuration name displayed in "Streaming configuration" list on the conference edit page.
  2. 2. Direct link to conference stream (RTSP URI).
  3. 3. This section includes additional settings for current streaming configuration (see “Additional streaming configuration settings” in present user’s guide).


Additional streaming configuration settings

  1. 1,2. You can change audio and video codecs used for the stream encryption.
  2. 3. Check if you need to send outbound RTP streams via TCP protocol. UDP is used by default.
  3. 4. Response waiting time (in seconds) for the information about published conference stream being successfully received by streaming platform.
  4. 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.
  5. 6. Delay (in seconds) between stream publication attempts.
   

Public Web Conference

External (WebRTC or RTSP) users can join this conference type.Public Conference button will be inactive if the ability to create such events is not activated in your license.

Click Public Conference button to enter Event Generation menu, available for external participants:


Public conference

  1. 1. Conference Name Field. Eg. Marketing Department Meeting.
  2. 2. Following the link with the Conference mode (Role-based by Default) you will enter the Menu, where a choice of a conference type can be made – be it symmetric, asymmetric or role-based (see Conference mode section).
  3. 3. Owner (Conference owner) choice from the list of users field (see Owner section).
  4. 4. Conference ID that users can use to join the conference.
  5. 5. Maximum number of guests (external connections). Follow the Extend link to enter a page with your license description. Contact our managers to extend the number of external connections.
  6. 6. Check this box to allow external users, connected to the conference via browser (WebRTC) or RTSP broadcast video and sound to the conference.
  7. 7. Check this box to allow external users send chat messages while in the videoconference.
  8. 8. In this field you can add user to a conference (see Participants section).
  9. 9. Schedule selection (see Schedule section).
  10. 10. Broadcasting check is off by default. Enabling the check in this field you allow the ability to display RTSP on WebRTC page.
  11. 11. Description menu item adds accompanying text to the scheduled Event (e.g. adding accompanying text to reports of participants or event schedule). The text will be displayed on the Home Page when external users are connected.
  12. 12. Press to setup streaming (see Streaming)
  13. 13. API for integration with external site.

"Streaming" Section

Streaming

In this section you can view the list of existing streaming configurations and create new configurations. You can find the information on how to create new conferences in "Streaming" section.

"API"

"OAuth2" Section

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 frame 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.

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. Server administrator can manage third-party application permissions and access tokens obtained via this section.

Oauth 2.0 is used to authorize certain applications (clients) to access protected resources with limited scopes and rights. This method grants administrator a way to immediately block particular application or a user from accessing protected data without affecting other applications.

Using this protocol, third-party applications are authorized to access server’s API and perform actions on the server on behalf of the user. 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 methodAccess token scopeAuthorization 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 wideAccess 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 scopeAccess 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 also defines a set of permissions he or she grants to this application.
User’s scopeAccess 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.

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

Permission set given to a third-party application can be read differently depending on the access token scope obtained after OAuth 2.0 authorization.

PermissionServer wide scopeUser’s scope
сonferencesCreate, view, edit, delete, start and stop any conference on the server.If the user is the conference owner, he/she can create, view, change, delete, start and stop the conference.
If the user was listed among participants when conference was scheduled he/she can only view conference properties.
conferences.invitationsView, add, and remove any participants invited to the conference.For conference owners: view, add and remove participants invited to the conference.
For listed participants: view the list of participants invited to the conference.
conferences.participantsView the list of active participants that are currently in the conference; send a request to join the conference to other users or endpoints.For conference owners: view the list of active conference participants and send a request to join the conference to other server users.
For listed participants: view the list of active conference participants.
groupsCreate, view and edit names and rights of any server group.View names and permissions of the server groups if the user is a member of the group.
groups.usersView, add and delete any server group users. Editing of group’s address book is forbidden.View group user lists if the user is a member of the group.
usersCreate, view, change, and delete any server user. In LDAP mode only reading mode is available.View and edit user profile on the server.
users.addressbookView, add, and delete address book entries of any server user.View, add, and delete entries in user’s address book.
Creating new OAuth 2.0 application

API

  1. 1. Application name. Only displayed in the application list.
  2. 2. Поле переадресация URL field is only used for Authorization Code method. For other authorization methods please indicate the following address https://localhost/.
  3. 3. Permissions set which is described in the previous section.
  4. 4. Don’t forget to save the information to create 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 TrueConf Server 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.

"File Storage" Section

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


File storage

  1. 1. Select a location of the files directory. You can use network paths.
  2. 2. Available free space on logical drive used for storage.
  3. 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, maximum value is several million years. If you do not want your files to be removed, select 10,000 days or more to ensure that your files are stored safely.
  4. 4,5. Use the slider to set maximum upload and download speed limits to upload or download the files from the server.
  5. 6. Save changes.

"Recordings" Section

This tab allows you to manage recording settings and lists previously recorded conferences.


Recordings

  1. 1. Select in the dropdown menu the recording option - disabled, enabled for multipoint conferences or enabled for all types of conferences. If selected "Enabled for multipoint conferences", you will set up automatic recoding for symmetric and role-based conferences and video lectures. If selected "Enabled for types of conferences", personal conferences (in the video call mode) will be recorded as well.
  2. 2. Enter the name of the folder to save the video and click on "Apply". By default the path is shown in the format [server work folder]/Recordings. The list of recorded conferences displays videos from the chosen folder. If the path is changed, the list will also change. Before you save the changes of the path, the notification will be displayed "The list of recorded conferences will be changed because of the changed directory". If you accept the changes, click "Ok". If you click on "Cancel", the path will stay the same. The recording will be saved in the specified path including network path in case TrueConf Server service has the permission to save recordings into this directory.
  3. 3. Limit recording and broadcasting resolution to 360p, 480p or 720p.
  4. 4. During the recording it will show a red indicator. When the recording has stopped and the conference has finished the indicator will be a green arrow that will lead to the file with the recorded conference.
  5. 5. Click on it to delete the recording.

"Endpoints" Section

This tab allows to view information about the endpoints.


Endpoints

  1. 1. Select the number of connections displayed in the table.
  2. 2. Name of the Endpoint, registered on the server. Endpoint's name is unique and depends on the computer and client software.
  3. 3. TrueConf ID of the users connected to the server at the moment.
  4. 4. Name of the clients software and version of the software.
  5. 5. Input field for connection name.
  6. 6. The user's IP address.

Sound capture and playback information

Example of Endpoint’s properties:

            Audio Capture:
            Microsoft Sound Mapper
            Avance AC'97 Audio
            Logitech Microphone (Pro 4000)
            
            Audio Render:
         
            Microsoft Sound Mapper
            Avance AC'97 Audio
        
Video capture device information

Example of Endpoint’s properties:

            Video Capture:
            Logitech QuickCam Pro 4000
            NAS Polycom Video Source Filter
            vvd.dll
        
DirectX information
            Direct X:
            
            Version:      9.0
            Driver:       ati2dvag.dll RADEON 7200 SERIES
            Resolution:   1024x768, 32 bit  
            Video Memory: total - 29679616, free - 29679616
            Capabilities: | Bu | Bd | Ou | Od |BFcc|OFcc|YUY2|UYVY| HB |
                          | 1  | 1  | 1  | 1  | 1  | 1  | 1  | 1  | 1  |
            DX INIT OK
        
DirectX features description

The assumed terms: 1 – is supported, 0 – not supported.

PropertiesDescription
VersionVersion of the installed DirectX
DriverName and description of the video card driver
ResolutionScreen resolution and number of colours
Video MemoryVideo memory volume
CapabilitiesCurrent driver capacities
BuUpward scaling
BdDownward scaling
OuUpward scaling using overlay
OdDownward scaling using overlay
BFccScaling without using RGB video data representation
OfccScaling using overlay without using RGB video data representation
YUY2Ability to use video data in the YUY2 format when displaying something on the screen
UYVYAbility to use video data in the UYVY format when displaying something on the screen
HBbilinear upward scaling
Connection information

Example of Endpoint’s properties:

            Network Info:

            Type:      I don’t know
            Broker:    srv1:1
            Host:      192.168.61.205
            Port:      4307
            Protocol:  InternetOptions
        
Network Test information
            Network Test:
            
            Parameter        |     IN  |     OUT   |
            ---------------------------------------|
            Bitrate, kBit    |  10000  |    9983   |
            Total, kB        |   7499  |    7499   |
            Jitter Max, ms   |     20  |      10   |
            Jitter Min, ms   |      0  |       0   |
            Response, ms     |     50  |       0   |
            ---------------------------------------|
            Date:           Thu Jan 22 17:08:19 2004
        
PropertiesDescription
TotalTotal amount of information transmitted during the Network Test
Jitter MaxMaximum deviation of the arrival time of the packet in the network from the mean value
Jitter MinMinimum deviation of the arrival time of the packet in the network from the mean value
ResponseServer response time
Last conference information

Example of Endpoint’s properties:

            Last Conf:

            Name        0000001d@srv1:1
            Bytes   s/r    73/0     kB
            Bitrate s/r    12/0     kbit
            Duration    00:00:46
        
PropertiesDescription
NameName of the conference
Bytesthe number of sent / received KBytes
Bitratethe average throughput when sending / receiving data
DurationDuration of the conference (hh:mm:ss)
System information

Example of Endpoint’s properties (It looks like PC is not equpped with a camera):

            Hardware Config:
            
            Video Capture:   None
            Audio Capture:   Avance AC'97 Audio
            Audio Render:    Avance AC'97 Audio
            
            sys_conf:
            
            Windows 2000 Advanced Server Service Pack 2 (Build 2195)
            Proc: Type 586 Level 6;
            Client: TrueConf
        
Events leading to the updating of information about the Endpoint

The following information will be updated when a connection with the server is established or resumed:

  • Current Network Info Type;
  • Audio Capture, Audio Render, Video Capture, Direct X – updates during client software start;
  • Hardware Config – updates during application shutdown.

Updates during a conference:

  • Last Conf Name.

Updates after running of the Network Test (menu Setup/ Network in client application):

  • Network Test.

Updates when logging in to the server:

  • System information.
Information shown in manager program is corrupted or couldn't be saved

Trouble: Your changes in manager are corrupt or couldn't be saved. After the manager has restarted some information is missing.

Possible reason: No access to registry or registry is corrupt.

Workaround: Grant read-write access to registry. Open manager as a user with administrator rights if needed. Reenter the information.

"Manage add-ons" Section

This section includes experimental features designed to extend your server functionality by integrating the server with third-party services and products. We do not describe existing add-ons, because interfaces of third-party services are often changing without notice. In such conditions we could not guarantee the accuracy of this guide.


Nevertheless, we have tried to make the interface for add-ons accurate and user-friendly. We also wrote great instructions on how to use these add-ons in our blog.