TrueConf Server Administrator Guide

  1. Server Side
    1. System Requirements for TrueConf Server
    2. Installation
    3. Registration
    4. Offline registration
    5. Administering the Server
    6. Changing the registration key
    7. Server status
    8. Server log
    9. Configuring preferences
  2. Client Side
    1. Where can I find client applications?
    2. Platforms supported by TrueConf client apps
    3. Client application features
    4. How to connect client app to your server
      1. Manual setup of the client app
      2. Connection using auto discovering
    5. How to update client apps?
    6. Сall string formats
      1. Call string format for TrueConf Server users
      2. Call string format for calling SIP endpoints
      3. Call string format for calling H.323 endpoints
      4. Call string format for calling RTSP endpoints
  3. Configuring Server
    1. "Dashboard" Group of Settings
      1. "Summary" Section
      2. "Settings" Section
    2. "Network"
      1. "Network settings" Section
      2. "SMTP" Section
      3. "SIP Gateway" Section
        1. Invitation of the SIP terminal to the conference that is held on the TrueConf Server
        2. Connecting SIP endpoint to the conference via CID (Conference ID)
        3. Invitation to the conference from TrueConf Client
        4. Troubleshooting
      4. "H.323 Gateway" Section
        1. How to Сall TrueConf Users and Conferences from H.323 Devices
        2. How to Register H.323 Devices on TrueConf Server
        3. 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
        1. User accounts
        2. User profile
      2. "Groups" Section
        1. "Editing Group List" Section
        2. Setting Up Address Book for Users of the Group
        3. Setting Application Settings for Group Users
      3. "Aliases" Section
      4. "User storage" Section
        1. Registry Mode
        2. LDAP Mode
    5. "Group Conferences" Group of Section
      1. Conference list
        1. Creating video conference
        2. "Conference mode" Section
        3. "Owner" Section
        4. "Participants" Section
        5. "Schedule" Section
        6. "Streaming" Section
      2. Streaming
    6. "API"
      1. "OAuth2" Section
    7. "Reports" Section
      1. "Events" Section
      2. "Call History" Section
        1. Call List
        2. Call or Conference Information
        3. Connection Properties
      3. "Chat Messages" Section
      4. "Configuration Changes" Section
      5. "Conference Recordings" Section
      6. "Endpoints" Section
        1. Events that update device information
    8. "File Storage" Section
    9. "Recordings" Section
    10. "Manage add-ons" Section

Server Side

Server Side сonsists of two components:

  • TrueConf Server;
  • TrueConf control panel.


TrueConf Server


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

  • Client authentication and authorization;
  • Making video conferences and point-to-point video calls using SVC technology
  • Storing server event history (call history, authorization log, chat history etc)
  • Connecting clients through NATs and proxy servers
  • Media stream retranslation when direct stream translation is not possible;
  • Multiprotocol gateway (SIP, H.323, RTSP) for integration with external communication systems and devices (including Skype for Business).
  • Communication between remote servers connected to the option "Federation";
  • Working in LAN without internet connection


Control panel TrueConf


This component allows you to modify server settings while it is running. TrueConf control panel 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.



 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/2016 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) - responsible for accessing control panel;

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

  • Port 4307 (may be changed in the control panel) - 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.


During the installation you can specify:

  • port for accessing control panel;
  • TCP port for server’s database;
  • installation directory.

The ports are selected during the installation and cannot be changed afterwards without fully reinstalling the server. By default the control panel is given port 80 or port 8888 if port 80 is not available. If both ports are unavailable then the user needs to specify a different port during installation.
If control panel port is not 80 then every time you start the control panel you have to specify the port in the browser’s address bar after the colon (e.g. http://localhost:8080)


Setup


Can I install TrueConf Server on a PC with a web server already installed?


Yes. The installer will either auto-select available port, or give you the option to assign the port manually


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 "Submit & Download":


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


Once the server has been successfully registered, you will see "running, registred" at the top-right corner of the control panel window.


Status server



Offline registration


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 Registration section.


When you receive an email with the registration key you need to put it in the appropriate field "Registration key" in the control panel on a computer without internet connection and click Registration.


Input registration key


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


The generated file offlinereg.vrg will be saved in the browser’s default download folder. Please send the file to . You will receive a file that needs to be installed on the PC with the offline-registered server.


Important: Please do not try to start offline registration again until you receive the file from TrueConf sales team. After restarting offline registration you will require to go through registration process again.


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


Continue oflline registration


If registration has been successful control panel page opens to notify you that the server has been 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 control panel is launched.


If Allow admin access from localhost without authentication option is checked in the Web > Security window, the control panel can be accessed without password authorization from the machine where the server was installed on ( localhost or 127.0.0.1 host in browser).


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 control panel, the administrator must add the user account to the "TrueConf Server Admin" group.


How to Control the TrueConf Server Out of Network ->
How to Connect External Users ->



Changing the registration key


You can change the registration key by going to Dashboard > Summary and clicking Registration.


Register


Enter a new key and click Registration:


Registration


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.


To disable this bond please contact our support:

Telephone: 1-347-878-3263

Email: sales@trueconf.com



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:


Server status



What to do if server is not running?


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


Server status


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 log


If you encounter any issues with TrueConf Server, our support team will be able to help you troubleshoot them faster and more efficiently if you provide them your server log files. To view the log, go to System > Server log located in the top-right corner of the window.


In order for the logs to contain as much details as possible you need to check the box "Enable full logging" in the Settings page of the control panel.


View log


You can download the report by clicking on the button above the log text:


View log



Configuring preferences


General settings for control panel configuration, such as interface language and time zone. You can access these settings in System > Preferences menu.


Export to CSV section allows you to export the logs in *.csv format. Every line of the report matches the corresponding line of the table, and the contents of data cells are separated by a symbol that you can select in the appropriate field under the "Encoding method".


After making changes to the settings click Apply to save them.


Preferences


  1. 1. System menu item to enter Preferences
  2. 2. Control panel settings
  3. 3. Report export settings



Client Side

To be able to use video conferencing services the user must have a TrueConf Client application installed.



Where can I find client applications?

Send out the guest page link to server users where they can download client applications for any platform they are using.


The guest page is available at: http[s]://<server>[:<port>]/guest where:

  • <server> - address of the PC with TrueConf server installed;
  • <port> - port for accessing control panel. You do not need to specify the port If the server’s control panel is using port 80 (which is set by default during the installation);
  • [] - optional elements.

Guest page



Platforms supported by TrueConf client apps


Legacy version of our client application is available only for Windows. We recommend our new cross-platform app that incorporates all TrueConf Server features.


Installation files for client app desktop versions (Windows/Linux/macOS) can be downloaded from our website. The apps for mobile platforms (Android, Android TV, iOS) can be downloaded from Play Market or App Store.


It is recommended downloading TrueConf app for macOS from AppStore in order for the app to auto update itself.



Client application features


Once installed on a PC, desktop apps allow users to:

  • Authorize as TrueConf Server user;
  • Configure device settings of your mic and camera as well as control them (turn on/off) during a conference;
  • Create / join video calls and conferences, invite users;
  • Vote during video conferences;
  • Change video layouts;
  • Share desktop or a separate application window;
  • Show slides;
  • View call history;
  • Create address book for quick dial-up;
  • Exchange text messages and files with other users.

The full list of features is much larger and is updated regularly. You can check all updates in our blog.


To learn more about mobile apps features, read the description in the application store.



How to connect client app to your server


To connect the app to your server and enable user authorization you need to specify the server address.


You can either do it manually or let the application locate it automatically via DNS.



Manual setup of the client app

To set up the client app manually the user needs to enter the server address and the access port in the network settings (or at the first launch of the program).


Detailed guide on connecting different types of client apps is available on our website.



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:

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

Configuring DNSDNS


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



How to update client apps?


TrueConf Client legacy application updates automatically when a new version of the server is released.


To update other TrueConf applications you need to manually download the new version from our website or get the updates via the corresponding application store for Android/Android TV/iOS or macOS.



Сall string formats


TrueConf Server not only enables server users to participate in video calls and conferences, it can also connect SIP, H.323 or RTSP endpoints to video sessions. For each type of endpoint there is a specific call string format that identifies the user you want to connect to and the gateway to be used.


The following call string formats can be used for identifying users in every control panel or client app menu that contains their contact information:

  • calling a user via the client app;
  • adding a contact to the address book;
  • adding a user to the conference;
  • creating an alias;
  • and much more.


Call string format for TrueConf Server users

To call the server user, enter the user’s TrueConf ID in the call-to field.


You can also call users of a different TrueConf Server instance. To do that use the following call string format: <TrueConf_ID>@<server>, where

  • <server> is a call-to IP address or server name;
  • <TrueConf_ID> - is a call-to user identifier..


Call string format for calling SIP endpoints

One of the following formats can be used for calling a SIP endpoint:

  • #sip:<user_id>@<server_name>, where:
    • <server_name> - is a host name or IP address of the SIP server;
    • <user_id> - is the SIP user’s name.
  • #sip:<user_id>@[<server_name>], where:
    • <server_name> - is IPv6 SIP address;
    • <user_id> - is the SIP user’s name.
  • #sip:<user_id>, where:
    • <user_id> - is the SIP user’s name;
    • Note: the call will be directed to the server that had been configured as Default SIP Proxy server by ticking a corresponding box (in the Network > SIP Gateway tab)
  • #tel:<user_id>, where:
    • <user_id> - is the SIP user’s name;
    • Note: the call will be directed to the server that had been configured as Default VoIP server by ticking a corresponding box (in the Network > SIP Gateway tab)
    • Note: #tel:<number> call string will be used for calling the <number> from the app’s dialer.
  • #sip:@<user_ip>, where:
    • <user_ip> - is IP address of the SIP user.
  • #sip:@<hostname>, where:
    • <hostname> - is DNS name of the SIP endpoint.

Call string examples:
#sip:james78@sipnet.com
#sip:james78
#sip:@192.168.0.7
#sip:@[fe80::805a:1cf9:12f9:def7%6]



Call string format for calling H.323 endpoints

The following call string formats can be used for calling an H.323 endpoint:

  • #h323:@<ip>, where :
    • <ip> is IP address of the H.323 endpoint.
  • #h323:@[<ip>], where:
    • <ip> is IPv6 address of the H.323 endpoint.
  • #h323:<user_id>@<ip>, where:
    • <ip> is IP address of the H.323 endpoint;
    • <user_id> is ID of the user or the device registered on the H.323 endpoint with the IP address specified in the <ip> parameter.
  • #h323:<user_id>@[<ip>], where:
    • <ip> is IPv6 address of the H.323 endpoint;
    • <user_id> is ID of the user or the device registered on the H.323 endpoint with the IP address specified in the <ip> parameter.
  • #h323:\e\<e164_id>@<ip>, where:
    • <ip> is IP address of the H.323 endpoint;
    • <e164_id> — is number in E.164 format of the user or the device registered on the H.323 endpoint with the IP address specified in the <ip> parameter.

The following formats can only be used if one of the created H.323 rules has its role set to Default H.323 gatekeeper (in this case the server specified for that rule will be used):

  • #h323:<user_id>, where
    • <user_id> — is ID of the called H.323 endpoint.
  • #h323:\e\<e164_id>, where
    • <e164_id> — is the number of the called H.323 endpoint in E.164 format.


Call string format for calling RTSP endpoints

To join an RTSP-stream (as well as add it to the conference) you need to use the call string format #rtsp:<address>, where the <address> can be an http or an IP address of the stream (e.g. #rtsp://222.11.1.100/axis-media/media.amp).


To learn more about using RTSP streams from TrueConf applications, go to RTSP Video Surveillance section on our website.



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.


Summary


Should any issues occur during server registration, the administrator can contact TrueConf technical support using the contact details provided.


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


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.



"Settings" Section

In this section you can set the path for saving TrueConf Server data, view server statistics and configure client apps.


Settings


  1. 1. Server working directory for saving log files.
  2. 2. Enable detailed logging.
  3. 3. Create a backup file with server settings
  4. 4. Restore your settings using a backup file
  5. 5. Client application download links, displayed as buttons on the guest page
  6. 6. This key is used to generate session keys for identifying users in a conference. To re-generate the key press "Generate a new key". Generating a new key during a conference may increase its security (making it harder for a third party to connect).
  7. 7. A key similar to the previous one. In this case it is used to connect guest accounts in public conferences.
  8. 8. Limit the output bitrate from the server to a client.
  9. 9. Limit the maximum frames per second rate transmitted by the server to a client.
  10. 10. Limit frame size in pixels.
  11. 11. Display user statuses (reaction icons) during the conference.
  12. 12. Save application settings.


Configuration


TrueConf Server settings backup file allows you to keep basic server settings for users, groups, scheduled conferences, and network settings in a backup file making it easy to return your server to the needed state. This feature is especially useful after an operating system reinstall or when moving a server to a different machine.


You can find the full guide on making a backup copy of and restoring the settings after a server transfer on our website, in the Knowledge Base.



Client app version settings


You can put a restriction on the versions of TrueConf apps listed below on this page limiting their access to video calls and conferences run on your server.


By clicking on a client app on the left side of the table you will open a settings window:


Client app version settings

  1. 1. Minimal version of the client app supported by the server. If the current version of the app is older than the one specified in the "Minimal version" field, the app will stop and force updates.
  2. 2. Currently preferred version of the client app. If the version of the app is older than the version specified in the "Current version" field, the user will be offered to update their app.
  3. 3. Suggested application version to be updated in the cases described above.


"Network"


"Network settings" Section

In this menu you can set the internal and external addresses.


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. Port used by SMTP server.
  3. 3. Secure authorization options - STARTTLS/ SSL protocols or disable secure authorization.
  4. 4. Authorization options: without authorization, password authorization.
  5. 5. If you have selected password authorization method, you will need to specify username for connecting to SMTP server.
  6. 6. Password for connecting to SMTP server.
  7. 7. Enter the email address which will be used to automatically send emails to the users
  8. 8. Checking SMTP server connection status
  9. 9. 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).
  10. 10. Email address of the TrueConf Server administrator. Server restart notifications will be sent to this address
  11. 11. Sending e-mail notifications to the users with missed calls
  12. 12. Restoring Default e-mail templates
  13. 13. Editable example of subject and body of the letter about the missed call to unregistered users
  14. 14. Editable example of subject and body of the letter about the missed call to registered users
  15. 15. Activation of an automatic user notification with the upcoming participation in a video conference
  16. 16. Ready-to-edit e-mail template with an invitation to the Group conference
  17. 17. Apply changes.

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


"Host" and "Port" fields must also contain your email information.


If the external mail server requires SSL (a protocol for secure authentication) for authorization, check "Use ssl" box.


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 TrueConf Server user, this event will be logged on the server and the user will be notified by email. You can customize the email content as you see fit.


In case of a non-recurrent conference, the user will receive an invitation letter when the conference is created. In case of a scheduled conference, the invitation letter will be sent out shortly before the start of the conference


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

  • %caller_display_name – display name of the caller;
  • %recipient_display_name – display name of the user who missed the call;
  • %recipient_call_id - ID of the user who missed the call (e.g. user@ub3xz.trueconf.name);
  • %missed_call_time – time of the call;
  • %conf_name" - name of the conference;
  • %conf_id - ID of the conference. E.g. \c\df0a2adebe;
  • %user_display_name - display name of the user;
  • %start_time - time and date of the conference start. The time specified in the email is in GMT +00:00 format so be aware of your time zone difference;
  • %caller_call_id – ID of the user who made the call;
  • http://%host/c/%conf_id - conference link for joining from PCs, mobile devices or browsers. E.g. http://192.168.66.107:8080/c/df0a2adebe;
  • http://%host/c/%conf_id#help_vcs - user guide for joining conferences via H.323/SIP endpoints;

Server administrator contacts:

  • %admin_name
  • %admin_email
  • %admin_phone


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


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


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.


Support of control cameras via Q.922/H.224/H.281 protocols determines whether users of a point-to-point video call or the moderator of a video conference are able to control the participants’ cameras


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


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.


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

  • create and plan a group video conference, using the tab "Group conferences";
  • assign the SIP endpoint as a participant of the conference (select it from the address book, if it is listed there, or add a call string in one of the above mentioned formats to the list of participants).

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 Conference ID (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

To create a conference where SIP users will participate among others:

  • 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 "Call string format for calling SIP endpoints";
  • organize conference in the TrueConf Server configuration wizard or client application TrueConf Client;
  • invite the endpoints from the address book to the conference.


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.

In the SIP Gateway tab check if the entered data is correct:

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


Calling up devices via H.323 gateway requires specific call string formats.


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


New Rule Form


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.


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


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.


Support of control cameras via Q.922/H.224/H.281 protocols determines whether users of a point-to-point video call or the moderator of a video conference are able to control the participants’ cameras.


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 С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.
  • \c\CID@Server, where CID is ID of the conference on TrueConf Server and Server is TrueConf Server IP address.
  • 00CID@Server, where first two characters are zeroes, CID is ID of the conference on TrueConf Server and Server is TrueConf Server IP address.

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. Select Windows users that will have administrative access.
  2. 2. By default accessing and managing the server from the IP addresses specified below does not require user authorization. Disabling this option will make authorization mandatory for all users.

    Attention! Before checking this box make sure you have a user on this computer that is in the security group - TrueConf Server Admin. Otherwise after applying the changes you will neither be able to authorize yourself nor enter the control panel. If that happened reinstall the server or contact our support team.

  3. 3. Check this box to limit access to your server to the IP addresses specified on the list.
  4. 4. Press this button to add a subnetwork with access to the control panel. Add the address in the Network address field (admissible symbols are – numbers and dots, admissible format – 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.
  5. 5. Secret security key for accessing API of your TrueConf Server. The security key provides permanent access to your server’s API until the security key is changed. Hence we recommend using the secret key only for testing API, and using OAuth2 for regular work with it.
  6. 6. Click to generate a new secret key. Reverting to the previous key or using your own is not possible.
  7. 7. Click to apply the changes.


"HTTPS" Section

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


НTTPS


  1. 1. Select one of the three operating modes:
    • Disable HTTPS - HTTPS protocol will not be used
    • Use self-signed certificate - this mode uses a certificate automatically obtained from the server (this certificate is not suitable for connecting external users via WebRTC).
    • Use custom certificate - this mode uses a certificate uploaded by TrueConf Server administrator.
  2. 2. Click here to go to the full user guide in our blog.
  3. 3. Set TCP port, which will be used by the web server for operating via HTTPS (use numbers) protocol. Port 443 is set by default.
  4. 4. Specify which protocol versions are supported by your server (select at least one version).
  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.
  6. 6. Click this button to save a web server configuration file and restart the server. Upon clicking on this button a dialogue box will be shown, notifying the user that this action will lead to a reboot of the server. TrueConf and Apache reboot processes start up simultaneously because TrueConf Server uses the same certificate to run WebSockets WSS secure channel.
  7. 7. Generate a new certificate. The "Self-Signed Certificate" section will appear as shown on the picture only if this certificate type has not been issued before. If the certificate was issued before, this section would contain the main parameters of root certificate and certificate which will be used by the web server and TrueConf Server (see Self-Signed Certificate section).
  8. 8. Select the appropriate certificate and key fils and click Upload. Custom certificate section looks like this only if this certificate type has not been issued before. If the certificate has already been downloaded, this section would contain the main certificate data (see Custom certificate segment below).

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.



"HTTPS Configuration" Section


In this section you can select your certificate and set other HTTPS parameters.


Web server applies HTTPS settings at startup. If invalid certificate port and parameters are entered, web server will not start and administrator will lose access to the control panel. Therefore it is required to carefully check the parameters beforehand.


Press Test configuration for your server to check if your HTTPS port is available.



Self-signed and custom certificates


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


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

  • self-signed certificate is valid for 365 days and can be generated from TrueConf Server control panel;
  • this certificate can be renewed for unlimited period of time;
  • with self-signed certificate, you can test WebRTC without purchasing a trusted certificate.

However, self-signed certificates have their own peculiarities. For example, root certificate installation process differs in Chrome and Firefox browsers.



Self-Signed Certificate


Self-signed certificate


To create a new self-signed certificate for TrueConf Server, press Create new SSL certificate. You may use this option to renew your certificate for 365 days or to update information about your company in the certificate (if your company’s name has changed).


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



Custom certificate


If the certificate has already been downloaded, this section will contain 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

User accounts

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.


User Accounts


  1. 1. Adding a new user.
  2. 2. Refreshing information about the user.
  3. 3. Searching for users.
  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.



User profile

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


Edit user


  1. 1. Switching user to active or inactive status. If the status is inactive, user account still exists, but the user cannot authorize via account details.
  2. 2. Disconnecting user from the network. You may use this option to allow another user to connect to your TrueConf Server instance a maximum number of connections in your license has been reached.
  3. 3. Unique name used to authorize in client application and make calls. Username may contain only Latin characters, numbers, underscores, hyphens and full stops. Server name is indicated next to the username (@<server> near the input box) to call other server users. Username is set when creating user account and cannot be modified later.
  4. 4. User password. You can change your password anytime.
  5. 5. Email address to send user notifications via SMTP connected to the server.
  6. 6. Entered name will be displayed in address books of other users. This field is prefilled as <ID>@<server>, where <ID> is a username entered in step 3, and is your server name. However, field value can be changed.
  7. 7. User’s personal details. These fields are not required.
  8. 8. Defines user group. Click the arrow to view existing groups on the server. To add a user to the group, check the field on the left of the group name.
  9. 9. User’s mobile, work or home phone number.
  10. 10. Save changes in user account. Remove user account. Go back to the previous page.

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


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


User application settings prevail over user group settings. If the user has smaller limitations as compared to user group limitations, only user limitations will be applied.


Application settings


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


You can add individual records which will be displayed only for edited user. Please note that you can add not only TrueConf Server user, but also SIP/H.323 or RTSP users to the address book


Edit address book


  1. 1. Interface used to add a user into the list. Start typing user’s name and you will see name options in the dropdown list.
  2. 2. The list of the groups where user belongs and address books of which are included in the user’s address book without removing option.
  3. 3. User profile from the address book.


"Groups" Section

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


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


Groups


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


At the group level you can allow or forbid:

  • Editing address book. By checking this field, administrator allows users to change users display names of the users, delete/add users and perform any other changes in the the group’s address book. If the box is not checked, group users will not be able to perform the actions mentioned above. In this case, all changes are performed by administrator in TrueConf Server control panel and extend to all address books of the users from this group;
  • Making point-to-point calls;
  • Content sharing and slide show;
  • Creating group conferences;
  • Operator Rights. Operator right enables a group participant to become a moderator of any conference he or she joins.

These settings allow to give server users different rights.



"Editing Group List" Section

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


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 the group being edited, press Rename. The following window opens:


Rename group


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



Setting Up Address Book for Users of the Group

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


In the address book menu you can add groups of all the users belonging to any other group to the address book of the group (i.e. to the address book of every member of this group).


Edit address book of group


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



Setting Application Settings for Group Users

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


Applications settings for group



"Aliases" Section

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


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


Aliases


  1. 1. An alias may contain numbers and letters. The maximum number of characters is 32. You can update aliases only after restart you have restarted the server.
  2. 2. TrueConf ID of the user or call string. The calls to aliases will be redirected to this TrueConf ID. One user may have several aliases.
  3. 3. Press the button to add a new alias to the list.
  4. 4. To delete an alias from the list, check the box on the left and press the button.

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



"User storage" Section

Syncing server with LDAP is unavailable in version.


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


User storage



Registry Mode

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


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



LDAP Mode

In this mode the server operates information about the users from removed or local LDAP directory. In LDAP mode you cannot edit user list and user group settings via control panel.


By default, configuration settings for LDAP match Microsoft Active Directory. User information is edited using Active Directory management tools.


In LDAP mode, user rights correspond to the Active Directory group where users belong.


To activate this mode, check LDAP > Enable mode and press Settings LDAP button at the bottom. LDAP settings window will open.


LDAP settings


  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 created via TrueConf Server control panel.



Conference list

Conference list


  1. 1. Add group video conference.
  2. 2. A link for conference web page.
  3. 3. Click the link to select a widget to integrate the conference window into external websites and systems.
  4. 4. Conference forced start. Before the start you will be offered to invite all the participants to the conference or select particular users. At conference forced start, only online users will be invited to the conference. Email invitations will not be sent out.
  5. 5. Edit selected conference.
  6. 6. Remove selected conference


Creating video conference

Click Create button in the Conference List menu you will need to select your conference type: private or public. You can use one of the templates you have saved earlier (template includes information about conference mode, participants, owner and other parameters). You can save new templates during conference editing.


Creating video conference


  1. 1. Select video conference mode to proceed to other parameter settings.
  2. 2. Or search saved templates and find a necessary one.
  3. 3. To avoid configuring the same parameters for different conferences, use saved template.
  4. 4. Remove unnecessary templates.


Private Conference


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


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. Choose your conference owner (see Owner section).
  4. 4. Conference ID that users can use to join the conference.
  5. 5. With UDP Multicast you can use network resources more efficiently because conference participant streams are directed bypassing the server. In this mode video and audio streams are transferred inside UDP Multicast domain. These domains can be used in the local network or VPN. Please check your license to see if this mode is available for you.

    If UDP Multicast mode is enabled while you are trying to connect to the conference using third-party protocols (WebRTC, RTSP, SIP, H.323, etc), video conference recording and streaming will be unavailable.
    Enabling this function is recommended only for those users who have hands-on experience in the sphere of network administration. Please note that it is your responsibility to check if this technology is available in your network

  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. Setting time and regular schedule for video conference. Learn more at Schedule section.
  9. 9. Link to the conference web page.
  10. 10. Adding guide text to the scheduled event (e.g. presentation description or event program). This text will be displayed on the conference page.
  11. 11. Press to setup streaming (see Streaming)
  12. 12. Press to configure video conference recording (see Recordings section).
  13. 13. Save conference settings as a template. In future you will be able to create a conference with such settings in one click.


Public Web Conference


External users (guests) can join public web conferences without authorization. If your license does not support this conference type, Public Web Conference button is unavailable.


Click on the Public Web Conference button to create the conference:


Public web conference


  • 1,2,3,4,8,9,10,11,12,13,15 fields are described in the "Private Conference section.
  • 5. Maximum number of guests (external connections). Click on the Increase link to proceed to your license description. To increase the number of external connections, contact our sales department at sales@trueconf.com.
  • 6. Check the box to allow guest users to broadcast their video and audio during video conferences.
  • 7. Check the box to allow guests to send chat messages during video conferences.
  • 14. HTML code for embedding video conference widget to your website.

Note: WebRTC conferences are available for Chrome, Opera, Mozilla Firefox and Edge users. Safari users of macOS also can participate in WebRTC conferences, but have limited access to its features. The license regulates guest connections for WebRTC conferences.



"Conference mode" Section

Click Symmetric link to choose conference mode.


Select conference mode


The maximum number of participants in a role-based conference depends on your license type. The number of participants can reach 250 users.
With , the maximum number of users in any group conference is 12 users.



Conference Modes


In symmetric group conference:

  • can have up to 36 participants at the same time;
  • all users can see and hear each other.

Symmetric group conference


In asymmetric group conference:

  • can have up to 36 participants at the same time;
  • one user (the owner) can hear and see all conference participants;
  • other users can see and hear only the Host.

Asymmetric group conference


In role-based conference

  • can have up to 250 participants at the same time;
  • up to 6 participants (speakers) can simultaneously broadcast video and audio to all conference participants (the maximum number of speakers is set when creating the conference and cannot be changed in the future);
  • other participants can hear and see speakers and make audio remarks to all conference participants;
  • any participant can become a speaker upon receiving moderator’s permission.

Role-based conference


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



"Owner" Section

Click Select to open the list of user accounts. Select the owner of the scheduled conference from this list.


Select owner of conference



"Participants" Section

The Participants field displays the number of participants that can be invited to the conference. Each conference mode is limited. By clicking on a number (e.g. "0/25"), you enter the menu where you can select conference participants and send invitations.



Selecting from the List of User Accounts


To add participants from the list of user accounts, click Select from the contact list button:


Edit list of participants


The list of your contacts will appear. When hovering over the contact name, you can see a plus sign. Click on the plus to add a user to the list of conference participants. After adding, this user appears in the left list:


Selecting participant from the list of user accounts


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:


Select 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 via ID or Call String


Click Add via ID to open a window designed to add users by ID (e.g. an external server user or a SIP/H.323 or RTSP device).


Add participant via ID or call string



Adding an Email to Send an Invitation


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


Add guests


In order for the Send invitations button to be active, your TrueConf Server instance should be integrated with SMTP server.



"Schedule" Section

By default, "Schedule" section is set to "No Schedule". Click on this link to open a menu where you can choose scheduling mode for your event:

  • Without schedule - This conference is started manually
  • Nonrecurrent - This conference launches automatically for the first time. Select the conference date, time, conference duration, and time zone.
  • Every week - Suitable for regular weekly conferences that start automatically. Week days, time, and time zone are set in advance.

Edit schedule


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



"Streaming" Section

Click Turn on link in the Streaming section. In the opened window you can configure streaming settings, change or disable them.


Streaming


Read more about how to create a new configuration in the Streaming section.


Please note that streaming is unavailable for UDP Multicast conferences.



"Streaming" Section

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


Streaming


To create a new configuration, click Add configuration button.


Streaming



Streaming through CDNvideo cloud service


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


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.



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



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



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


"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 redirect 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.



"Reports" Section


This section stores all information about user connections, calls, messages, and video conference recordings. Data can be filtered according to various parameters and downloaded in CSV format.


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


In the tables, time is displayed according to the time zone selected in the preferences menu.


Interface of reports table


These tables have common functions:


  1. 1. Filter entries;
  2. 2. Save tables in CSV format;
  3. 3. Sort entries by field values (click on any column name to change sorting order).


"Events" Section

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


Events


  1. 1. General table interface (see the description above);
  2. 2. Event details;
  3. 3. Link to an active user profile.


"Call History" Section

This section contains history and detailed information about video calls and conferences on the server



Call List

You can find any calls you like in the table on the main page of the section.


Along with call history, call list contains information about the current conference. End field remains blank for current conferences.


Call history


  1. 1. General table interface (see the description above).
  2. 2. Link to the page with detailed information about a call or conference.
  3. 3. Link to a profile of the conference or call owner.


Call or Conference Information

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

  • time and information about the conference owner;
  • list of the participants who attended the conference anytime;
  • history of conference invitations and reactions.

Conference Information


  1. 1. General table interface (see the description above).
  2. 2. Conference chat history button.
  3. 3. Link to user profiles of conference participants and invited users.
  4. 4. Link to the pages with each conference participant connection details.


Connection Properties

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


Endpoint properties



"Chat Messages" Section

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


Chat messages


  1. 1. General table interface (see the description above);
  2. 2. Links to user profiles of the sender and recipient of a private message
  3. 3. Link to a page with detailed information about the conference to the common chat of which a message was sent


"Configuration Changes" Section

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


Configuration changes


  1. 1. General table interface (see the description above).
  2. 2. Name of the modified parameter.
  3. 3. Previous parameter value (before making changes).
  4. 4. New parameter value (after making changes).


"Conference Recordings" Section

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


Conference recordings


  1. 1. General table interface (see the description above).
  2. 2. Link to the page with detailed information about a recorded conference or a call;
  3. 3. Link to a user profile of the conference moderator or video call owner;
  4. 4. Conference type: video call, symmetric, and asymmetric or role-based;
  5. 5. "Download" button
  6. 6. "Delete" button


"Endpoints" Section

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


Endpoints


  1. 1. Unique connection ID.
  2. 2. Select the number of displayed connections in the table.
  3. 3. Trueconf ID of the users who are currently connected to the server.
  4. 4. Name of the user’s client application and application version.
  5. 5. Field used to search for a connection. The system searches through all fields (once a table has been filtered, the system displays only those records that have at least one field with string entered).
  6. 6. User IP address

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

  • available playback and audio capture devices;
  • available video capture devices;
  • selected equipment settings
  • the latest conference where a device participated
  • directX properties
  • network connection
  • network test results

Endpoint properties



Events that update device information

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


"File Storage" 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, and maximal value is unlimited.
  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


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


Recordings


  1. 1. The path to the folder where all recordings are saved. Default recordings folder is located in the server working folder. The list of recorded conferences displays the videos from the specified folder. If the path is redefined, the list is re-formed respectively. In this field, you can also specify network path if TrueConf Server service has the rights to place recordings in this directory.
  2. 2. Enable / disable point-to-point video call recording. This option is similar for all calls: either all are recorded, or none are recorded.
    Please note that if you enable this option, you will not able to use direct connection between users (to be recorded, all information between subscribers is transferred through the server).
  3. 3. There are three options to set up group conference recordings: either all are recorded, or none are recorded, or recording is set separately for each conference ("Upon Request" mode).
  4. 4. Video quality of conference recording.
  5. 5. Video format of conference recording.
  6. 6. Time (in days) after which conference recordings should be deleted automatically. Click the checkbox next to the field to activate the text field. If you don’t check this box, recordings will be stored indefinitely (recordings are not deleted automatically).


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


Yes, but you will have to download and install a specific codec for that.


Once the installation is complete, start encoder configuration procedure. Select "libavcodec" decoder in the VP8 video encoder configuration window.


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



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