Upgrading a XiVO CC is done by executing commands through a terminal on the server.


Downgrade is not supported


The upgrade consists of the following steps:

  • switch the version via xivo-dist utility

  • update of the xivo-dist, xivocc-installer and xivo-chat-backend packages

  • update of the Docker images


This upgrade procedure applies only to XiVO CC installed via the xivocc-installer package.

Preparing the upgrade

There are two cases:

  1. Upgrade to another LTS XiVO CC version,

  2. Upgrade to the latest Bugfix release of your current installed LTS version.

Upgrade to another LTS version

To upgrade to another XiVO Solution LTS:

  1. Switch the sources to the new XiVO CC LTS version with xivo-dist, for example, to switch to Gaia LTS version:

    xivo-dist xivo-gaia
  2. Read carefully the Release Notes starting from your current version to the version you target (read even more carefully the New features and Behavior changes between LTS)

  3. Check the specific instructions and manual steps from your current LTS to your targetted LTS and all intermediate LTS: see Manual steps for LTS upgrade

  4. Check also if you are in a specific setup that requires a specific procedure

  5. And then upgrade, see Upgrading

Upgrade to latest Bugfix release of an LTS version


For version older than Five (2017.03), see XiVO Five documentation

After the release of a version (e.g. Freya (2020.18)) we may backport some bugfixes in this version. We will then create a subversion (e.g. Freya .04 (2020.18 .04)) shipping these bugfixes. These bugfix version does not contain any behavior change.

To upgrade to the latest subversion of your current installed version you need to:

  1. Read carefully the Release Notes starting from your installed version (e.g. Freya.00) to the latest bugfix release (e.g. Freya.04).

  2. Verify that the debian sources list corresponds to your installed LTS or refix it, for example for Freya:

    xivo-dist xivo-freya
  3. Verify that the /etc/docker/compose/factory.env file has

    • XIVOCC_TAG=VERSION (where VERSION is your current installed version - e.g. 2020.18)

    • and XIVOCC_DIST=latest

  4. And then upgrade, see Upgrading


After having prepared your upgrade (see above), you can upgrade:

  1. When you have checked the sources.list you can upgrade with the following commands:

    apt-get update
    apt-get install xivo-dist
    apt-get update
    apt-get install xivocc-installer xivo-chat-backend
  2. If there is any change, you should accept the new docker-compose.yml file. Then compare it with the old docker-compose.yml.dpkg-old file and report in the new any specific configuration.

  3. Then download the new docker images:

    xivocc-dcomp pull
  4. And run the new containers (Corresponding XiVO CC services will be restarted):

    xivocc-dcomp up -d --remove-orphans


Please, ensure your server date is correct before starting. If system date differs too much from correct date, you may get an authentication error preventing download of the docker images.

Post Upgrade

When finished:

Manual steps for LTS upgrade

See Manual steps for LTS upgrade in XiVO Upgrade page.

Specific procedures

Upgrade notes

See Release Notes for version specific informations.