TrueConf

# Initial configuration

An impersonation account is a special Microsoft Exchange account authorized to perform actions and view calendars "on behalf of" other users. This account is created by the Microsoft Exchange server administrator.

Before configuration you need to generate an encrypted password for the impersonation account by executing this command:

Windows

C:\Program Files\TrueConf\Calendar\tc_calendar.exe --hash_pass <password>

Linux

sudo /opt/trueconf/calendar/bin/calendar/tc_calendar --hash_pass <password>
  • where <password> is the password for the Microsoft Exchange impersonation account. If there are multiple passwords, list them separated by spaces (pass1 pass2 .... pass n).

Each password will have a unique version generated for it. Each line with the encrypted password corresponds to the order they are specified in the command line: Your encrypted data: dGNf....

# Configuration file description

To configure TrueConf Calendar Connector, use the file stored at this path: /opt/trueconf/calendar/etc/calendar/config.json.

The configuration file mentions the TrueConf Calendar Connector database which is intended for caching data from the Microsoft corporate server. This database helps to reduce the number of requests to the events server, which positively affects performance. The use of an encrypted password for database access ensures the security of confidential information and prevents unauthorized access. This practice complies with corporate data protection standards.

# Database and network port configuration

{
  "wsPort": 4315, 
  "dbConnectionConfig": {
    "host": "localhost",
    "port": 5441,
    "user": "bridge",
    "password": "", // by default, there is no password for database access, but if one is set, you need to specify the encrypted password previously created for the impersonation account here
    "database": "calendar"
  },

  • "wsPort" – the port for the WebSocket server operation, which does not require editing unless a different one was specified during installation.

  • "dbConnectionConfig" - this section is for database connection configuration. The parameters in this section are automatically generated during installation and MUST NOT be changed manually.

# Conference Setup

"launchConference": true,
"temporalConfParticipantsMode": false,
"cache": {
  "autoSync": false,
  "backward": 2,
  "forward": 3
}

  • "launchConference" is responsible for the automatic start of the conference. TrueConf Calendar Connector sends a request to TrueConf Server when an event starts in Microsoft Exchange.

  • "temporalConfParticipantsMode" is responsible for adding participants to the "scheduled" list. If false, all event participants who have not declined will be added as scheduled.

  • "cache" – section used for configuring automatic synchronization settings:

    • "autoSync" – if set to true, a full synchronization of calendar events will be performed. If set to false, previously created events will not be displayed or synchronized within the selected time period, but other events will be.

    • "backward" – the number of months back from the current date to display recurring events;

    • "forward" – the number of months forward from the current date to display recurring events.

# Configuring access to the video conferencing server

"productWhitelist": {
    "tcs": ["server.trueconf.name#vcs"]
 }
  • "server.trueconf.name#vcs" - you need to specify the address (or domain name) of TrueConf Server that will have access to TrueConf Calendar Connector.

# Configuring Access to Microsoft Exchange

On the Microsoft Exchange side, you need to pre-create impersonation accounts permitted to view calendars "on behalf of" other users.

  "calendarProviders": [
    {
      "host": "exchange.domen.com", 
      "path": "/EWS/Exchange.asmx", 
      "port": 443, 
      "type": "ews", 
      "credentials": [
        {
          "login": "test",
          "password": "encrypted_password"
        } 
        ],
      "users": [
        "name@domen.com"
      ]
    }
  ]
}

  • "calendarProviders" - section for specifying configurations of external calendar synchronization services;

  • "host" - the domain where the Microsoft Exchange server is located;

  • "path" - the path for accessing the EWS API (default path is specified);

  • "port" - the default port for connecting to EWS;

  • "type" - the name of the external service (only Microsoft Exchange is supported);

  • "credentials" - section for specifying the impersonation account credentials on the Exchange server;

    • "login" - the login for the corporate Exchange account;

    • "password" - encrypted account password. It is generated using the terminal;

  • The "users" section is mandatory. The emails added to this section will be used to send event information to TrueConf client applications.

# TrueConf Calendar Maintenance

Management of TrueConf Calendar Connector on Windows OS is handled through the task scheduler.

# How to start the calendar application

After specifying the required parameters described above, start TrueConf Calendar Connector with this command:

sudo systemctl start trueconf-calendar.service

If the launch limit is exceeded, run this command:

sudo systemctl reset-failed trueconf-calendar.service

# Calendar test

To test the work of TrueConf Calendar Connector, run this command:

sudo systemctl status trueconf-calendar.service

You will receive one of the responses

active (running) – TrueConf Calendar Connector is working normally.

failed – TrueConf Calendar Connector is NOT working. In this case, try restarting the service using the command described above.

In case of any issues, please contact our technical support.

← Working with the calendar →