Release Notes

Kuma

Below is a list of New Features and Behavior Changes compared to the previous LTS version, Jabbah (2022.10).

New Features

XiVO PBX

  • The web service configuration page has evolved. The password field is now hidden, and a strong password policy was added for security safety. You also have the option to generate a random password fitting the newly required policy.

  • The password generator button was also added to the cti password field, in user edition.

XiVO UC Addon

  • XiVO UC add-on environment was reworked to have only one database container (see Architecture schema). So now the pgxivocc and the db_replic containers are removed on this install type. We added a new variable UC=yes in files /etc/docker/compose/custom.env and /etc/docker/xivo/custom.env if we are in a UC Addon environment. Also the file /var/lib/xivo/xc_enabled was replace to /var/lib/xivo/uc_enabled on UC Addon environment.

API

  • New API are available through webservice users (which are different from cti users) with custom ACL.

System

  • Upgrade to asterisk 20 the latest LTS version of asterisk

  • Upgrade to postgresql 15 the latest release of postgres

  • Ease of installation process

  • Anonymous usage data collection

Behavior Changes

XiVO PBX

  • You will need to match the new password policy when creating web service users. (mandatory)

Deprecations

This release deprecates:

Upgrade

Manual steps for LTS upgrade

Warning

Don’t forget to read carefully the specific steps to upgrade from another LTS version

Generic upgrade procedure

Then, follow the generic upgrade procedures:

Kuma Bugfixes Versions

Components version table

Table listing the current version of the components.

Component

current ver.

XiVO

XiVO PBX

2023.05.08

config_mgt

2023.05.08

db

2023.05.06

outcall

2023.05.00

db_replic

2023.05.00

nginx

2023.05.00

webi

2023.05.08

switchboard_reports

2023.05.06

usage_writer

2023.05.02

usage_collector

2023.05.06

asterisk

20.2

docker-ce

5:20.10.13

docker-compose

1.29.2

XiVO CC

elasticsearch

7.14.0

kibana

7.14.0

logstash

2023.05.00

mattermost

2023.05.00

nginx

2023.05.00

pack-reporting

2023.05.00

pgxivocc

2023.05.00

recording-rsync

2023.05.00

recording-server

2023.05.03

spagobi

2023.05.00

xivo-full-stats

2023.05.06

xuc

2023.05.09

xucmgt

2023.05.09

Edge

2023.05.00

edge

2023.05.00

nginx

2023.05.07

kamailio

2023.05.00

coturn

2023.05.00

Meeting Rooms

2023.05.00

meetingroom

2023.05.00

web-jitsi

2023.05.00

jicofo-jitsi

2023.05.00

prosody-jitsi

2023.05.00

jvb-jitsi

2023.05.00

jigasi-jitsi

2023.05.00

IVR

2023.05.03

ivr-editor

2023.05.05

2023.05.09 (Kuma.09)

Consult the 2023.05.09 (Kuma.09) Roadmap.

Components updated:

Docker: xivocc-installer, xucmgt, xucserver

Debian: xivocc-installer, xivo

Web Assistant

  • #7373 - As an admin I want to be able to delegate authentication to Azure AD configured with OIDC

  • #7455 - Verify jwt token from OIDC auth delegation following the standard

  • #7456 - Use the standard endpoints of OIDC for login

  • #7457 - I want to be able retrieve the jwt token with the fragment encoding protocol

2023.05.08 (Kuma.08)

Consult the 2023.05.08 (Kuma.08) Roadmap.

Components updated:

Docker: config-mgt, xivo-agid, xivo-confgend, xivo-web-interface, xucmgt, xucserver

Debian: xivo-agid, xivo-confgend, xivo-config, xivo-provisioning, xivo-purge-db, xivo

CCAgent

  • #7382 - CC Agent autoreconnect dont work when xuc restart

  • #7467 - Error in the console when opening the dropdown of a meeting room in the search result

  • #7537 - Use the correct address for the cc agent autologin cypress test

Config mgt

  • #7400 - List users sometimes fails in webi due to a too short timeout

WebRTC

  • #7411 - Enhanced ICE gathering logs in webbrowser console

XiVO PBX

  • #7310 - As an admin I should not be able to delete user xuc technical

  • #7343 - MDS - The purge USM cron is executed on main (it should not)

  • #7429 - Call right on outgoing call (UC ASSISTANT)

  • #7435 - Enhance mobile_app_wake_up behaviour and timeouts

  • #7484 - Asterisk - PJSIP - SIP trunks are badly generated on each MDS of a XDS setup (even if linked to another one)

XiVO Provisioning

  • #7547 - Plugin “Zero” TFTP download timeout

2023.05.07 (Kuma.07)

Consult the 2023.05.07 (Kuma.07) Roadmap.

Components updated:

Docker :

config-mgt,edge-nginx,xivo-agid,xivo-confgend,xucmgt,xucserver

Debian :

debian-builder,xivo-agid,xivo-confgend,xivo-config,xivo-purge-db,xivo-python-kalyke-packaging,xivo-sounds,xivocc-installer,xivo

CCAgent

  • #7215 - Auto-reconnect does not work for CCagent

  • #7320 - As a CC Agent user I want to be able to be auto-reconnected after refresh or browser leave

    Important

    Behavior change Autologin in ccagent works as it was in Freya version.

    If you have a valid token, ccagent will connect automatically

  • #7325 - As a CC Agent user I want to be able to be auto-reconnected after network disconnection

    Important

    Behavior change Autologin in ccagent works as it was in Freya version.

    If you have a valid token, ccagent will connect automatically

Desktop Assistant

  • #7272 - desktop assistant INI file only works on launch

  • #7307 - Desktop assistant null token is propagated to UC assistant when autologin

  • #7322 - As i user i dont want the ini file to be taken in count after saving my settings

Mobile Application

  • #7210 - As an Admin I want to be able to register the push token distinguishing android/ios phones

  • #7226 - Be able to send push notification to a different server for android or ios

  • #7237 - Android Mobile App doesn’t wake up

  • #7281 - Mobile App - We need to send a callid in iOS push notification

Web Assistant

  • #7163 - Add upper limit on cti auth expiry just in case

WebRTC

  • #7324 - As an admin I want to be able to configure the ICE gathering timeout

XUC Server

  • #7304 - Dissuasion and recording indicator in ccmanager are broken

XiVO PBX

  • #7186 - The FR Mobile App message is not correctly formatted

  • #7191 - xivo-purge-db is broken since the add of USM purge line in crontab

  • #7248 - RTP ports cannot be modified due to hardcoded value in xivo-confgend

    Important

    Behavior change RTP can now be fully customized, by creating overrides in /etc/asterisk/rtp.d/ See details in the main file /etc/asterisk/rtp.conf

  • #7251 - Mobile App - Missing startup log about mobile app push server credentials

XiVOCC Infra

  • #7330 - Fix doc about CC silent install variable

    Important

    Behavior change even on edge environment, XiVOCC’s environment variable XUC_HOST MUST be set to the xivocc ip during the installation (you have to manually change it to the fqdn at the end of the installation)

2023.05.06 (Kuma.06)

Consult the 2023.05.06 (Kuma.06) Roadmap.

Components updated:

Docker :

config-mgt,xivo-agid,xivo-confgend,xivo-db,xivo-full-stats,xivo-switchboard-reports,xucmgt,xucserver,xivo-usage-collector,

Debian :

asterisk,xivo-agid,xivo-confgend,xivo-config,xivo-sounds ,xivocc-installer,xivo

Asterisk

  • #6872 - Asterisk 20.3.1 on master (for Kuma and later)

  • #7123 - Asterisk ICE threads are accumulating over time - 20.3.1 on debian11_ast20_kuma for Kuma

Config mgt

  • #6465 - Add Configmgt CRUD API for groups

Desktop Assistant

  • #6981 - Support signing of source code on Kuma

Reporting

  • #7095 - Unoffered events are not generated in xc_queue_call

Switchboard

  • #7078 - Cannot download switchboard reports

Usage statistics

  • #6904 - Unclear aggregation of login events

Web Assistant

  • #7120 - Phone status available are not always displayed correctly in history

XUC Server

  • #6976 - Token renewal should not use maxEpiry hard limit of one day for CTI token

XiVO LDAP

  • #7087 - update install jdk on debian 10 xivo-lib-ldap + handle ua / webrtc options

XiVO PBX

  • #6170 - XDS - A configured and installed MDS that is no more running makes XiVO (mds0) unstable

    Important

    Behavior change Media Server: The max_slot_wal_keep_size is now set to 1G, that means that if a MDS crashes or is uninstalled incorrectly, the Main won’t be filled up with data that the lost MDS did not replicate (as a consequence this lost MDS won’t be able to recover the replication after a certain number of operations in the base). see Database Replication

  • #6883 - Mobile App - As a Mobile App User I don’t want to wait more than 20s before my destination rings

    Important

    Behavior change Mobile Application: You can now configure the mobile application wait time and choose between music on hold or ringtone while waiting.

    See: Configuration

  • #7085 - USM - token renewal cron sends unwanted emails to root

  • #7141 - [PJSIP] Directmedia configuration generation does not enable direct_media if option is not yes

edge

  • #6859 - As an admin I want to see SIP Call-Id in logs in order to simplify mobile app (and kamailio) debug

    Important

    Behavior change If you had a custom pre-dial handler when calling a user, you should ensure that it calls Gosub(xivo-user-predial,s,1) to have the default behavior.

    Note: if your pre-dial handler called Gosub(xivo_header_mgr,set_headers_on_channel,1) it should be replaced by a call to Gosub(xivo-user-predial,s,1)

    See XiVO header manager for simplified PJSIP header management.

2023.05.05 (Kuma.05)

Consult the 2023.05.05 (Kuma.05) Roadmap.

Components updated:

Docker :

ivr-editor,xivo-confgend,xucmgt,xucserver

Debian :

xivo-ci,xivo-confgend,xivo

Desktop Assistant

  • #5609 - Add the framework for automated integration test of the desktop assistant

  • #6786 - Clean Xucmgt Electron dependancies

  • #6787 - Create Jenkins task for electron tests

DevSpe

  • #6718 - Create and configure pipeline for prod release

Visioconf

  • #6777 - Meetingroom : Add variable ENABLE_BACKGROUND_SELECTION in .env documentation

XUC Server

  • #6822 - Trying to connect to multiple unreachable mds leads xuc to stop working

XiVO PBX

  • #6634 - IVR menu invalid option

  • #6726 - logrotate seems not working for xivo-confgend on main or MDS

  • #6791 - Doc - Update doc with proper versions

XiVOCC Infra

  • #6719 - Automate the snapshots of the dev environments

2023.05.04 (Kuma.04)

Consult the 2023.05.04 (Kuma.04) Roadmap.

Components updated:

Docker :

xucserver

Debian :

XUC Server

  • #6779 - At startup xuc spams ctid creating the ctilink for every user

2023.05.03 (Kuma.03)

Consult the 2023.05.03 (Kuma.03) Roadmap.

Components updated:

Docker :

config-mgt,edge-nginx,ivr-editor,recording-server,xivo-confgend,xivo-db,xivo-web-interface,xucmgt,xucserver

Debian :

play-authentication,xivo-confgend,xivo-config,xivo-install-script,xivo-service,xivo-sysconfd,xivo-upgrade,xivocc-installer,xivo

Asterisk

  • #6621 - Load - fix xds scenario call group from mds1

  • #6660 - PJSIP config reload from Asterisk when using the exec & confgend mechanism is slow and delays SIP requests handling

    Important

    Behavior change PJSIP configuration change: from now on launching manually a module reload res_pjsip.so in asterisk CLI will not reload the pjsip configuration from the db.

    See How to reload the configuration ? to do that.

CCAgent

  • #6630 - [Edge] CCagent] Dissuasion configuration through Edge with CC Agent is blocked

  • #6635 - CCAgent - History display is broken : date & call status are not displayed in history entry

CCManager

  • #6713 - Changement de compteurs dans la vue globale du CC manager

Config mgt

  • #6466 - Add API to add or remove user from groups

  • #6636 - Add Asterisk configuration update when adding / removing user from group by api

Desktop Assistant

  • #6674 - Window is not focused when launching application already running

Recording

  • #6588 - LDAP authentification on the recording interface

Usage statistics

  • #6611 - USM - usage writer may not start after upgrade

  • #6613 - USM - usage collector not in the xivo-service

Web Assistant

  • #6653 - History requests are sent multiple times to xuc when a call is ongoing

WebRTC

  • #6325 - Opus is not activated for WebRTC users for Incoming call

    Important

    Behavior change We now ensure Opus codec is selected for calls towards WebRTC users. Given A a user Given W a WebRTC user. When A calls W, we ensure opus codec will be used on W’s channel (whatever the codec offered by A).

    This implies potentially more transcoding load on asterisk. Previously A’s codec was preferred (presumably G.711 A-Law) and then implying less transcoding by asterisk.

  • #6583 - Ice negociation timeout not working in scenarios where two calls are presented in quick succession

XUC Server

  • #6532 - Load monitoring - agent stats and reporting monitoring not working

  • #6572 - ACLs are not updated when renewing an existing webservice token

  • #6592 - When the credentials of a web service user are wrong, there is no specific error message

  • #6650 - Fix InvalidCredentials error (when credentials are correct) for web service users

  • #6686 - Remove old and unnecessary DialToQueue implementation

  • #6700 - The phone status updates are not send to opened Web socket

XiVO PBX

  • #6358 - Add default joinempty/leavewhenempty values for groups

    Important

    Behavior change Group will now execute the “failed” scenario when nobody in the group is connected

  • #6475 - [Doc] Describe the call quality visualisation feature

  • #6556 - added rights and member management for agi located in /var/lib/asterisk/agi-bin/

  • #6618 - Doc - update doc to reference postgres 15 folders instead of 11

  • #6680 - PJSIP - Correctly handle generate registration config when outbound proxy is set

    Important

    Behavior change Registration configuration with Outbound proxy, will now be generated in the pjsip configuration with the ;lr parameter to enforce Loose Routing (this is the recommended behavior and mimick more the chan_sip behavior).

    You can still change this by overriding the pjsip configuration as described here: ref:asterisk_sip_conf_customization.

  • #6697 - PJSIP - Contact generation problem in PJSIP

  • #6703 - Setting the docker variable db instead of the hard ip docker0

  • #6706 - Fix monit check for xivo_usage_collector

XiVOCC Infra

  • #6468 - mds-debconf | Change whiptail question using debconf in mds installation script

  • #6659 - Installation failed due to #XIVO_HOST variable in custom.env

edge

  • #6620 - [Doc] Complete network flows pre-requisite table with XiVO / Edge-Turn according to diagram

2023.05.02 (Kuma.02)

Consult the 2023.05.02 (Kuma.02) Roadmap.

Components updated:

Docker :

edge-nginx,xivo-usage-writer,xivo-web-interface,xucmgt,xucserver

Debian :

xivo-config,xivo-install-script,xivo-upgrade,xivo-usage-collector,xivocc-installer

CCManager

  • #6457 - Can’t import or donwload callbacks from CCManager when used with Edge

Desktop Assistant

  • #6580 - CCagent do not resize to correct size at startup of desktop assistant

Usage statistics

  • #5613 - USM - Usage Report

  • #6520 - Add xivo_uuid to the USM get token request

  • #6534 - Automate USM token renewal

  • #6544 - USM - add a monthly collection

WebRTC

  • #6360 - [Doc] - Clarify Audio Quality issue computation

  • #6479 - Packet loss warning does not work with Chrome 110 and higher

XUC Server

  • #6328 - Secure REST API

  • #6434 - Automatically update the repository of web service users with RabbitMQ

  • #6445 - XUC REST API - Bump old 1.0 API to 2.0 with authentication

  • #6531 - Webservice token is refreshed with AUTH_EXPIRES time when asking for renewal

XiVO PBX

  • #5951 - Remove chan_sccp support from XiVO

XiVOCC Infra

  • #6526 - The link between xuc and recording server is broken

2023.05.01 (Kuma.01)

Consult the 2023.05.01 (Kuma.01) Roadmap.

Components updated:

Docker :

xivo-web-interface,xucserver

Debian :

xivo-confd

XUC Server

  • #6524 - Cannot invite user to temporary meeting room

XiVO PBX

  • #6523 - Confd regex dont authorize password with length of 4

2023.05.00 (Kuma.00)

Consult the 2023.05.00 (Kuma.00) Roadmap.

Components updated:

Docker :

edge-nginx,xivo-db,xivo-outcall,xivo-usage-writer,xivo-web-interface,xivoxc-nginx,xucmgt,xucserver,xivocc-fluentd,xivo-grafana

Debian :

xivo,xivo-auth,xivo-confd,xivo-purge-db,xivo-service,xivo-upgrade,xivocc-installer

Desktop Assistant

  • #6474 - DApp - CC agent application does not resize the DApp size (dapp enveloppe)

Reporting

  • #6259 - Add purge mechanism for USM on XiVo main

Usage statistics

  • #6216 - configure usm telegraph to send data to a remote influxdb server

  • #6478 - Create USM VM

Visioconf

  • #6497 - When in a meeting room, if I receive another meeting room invitation I can’t quit my current MR to join the new invitation

XUC Server

  • #6375 - Check user ACL

    Important

    Behavior change Rest Api usage can now be restricted by ACL

  • #6451 - Visualising call quality from xuc

  • #6452 - Parsing compressed xuc logs into xivo_db

  • #6453 - Create a separate project for fluentd

  • #6461 - WebService - token is not recreated

  • #6487 - Change some default values on xucserver application.conf

  • #6507 - Fix the memory leak when a user is connecting to xuc

XiVO PBX

  • #6212 - Doc how I can restore a db backup of LTS N on a xivo LTS N+6

  • #6374 - Add default ACLs for CTI users

  • #6454 - Create a separate project for grafana

  • #6455 - Add purge mechanism to the call quality visualisation

  • #6458 - UC Addon - mattermost db restore fails

  • #6488 - Change some default values on xivo-outcall application.conf

  • #6496 - Broken webi user import

XiVOCC Infra

  • #4964 - Automate the WebRTC configuration for XiVOCC

  • #6225 - [Doc] MR for more informations on passing the wizard via JSON

  • #6290 - [S] Elastic Kibana - CVE - several vulnerability

  • #6332 - [SF] - XiVO Installation - provide minimal debugging & ops tools in base install

  • #6477 - Remove excessive permissions in pgxivocc

edge

  • #6471 - [S] - Edge - Call Qualification export API is accessible without authentication

Kuma Intermediate Versions