XiVO PBX will be reconfigured during the installation and must be restarted.
You may accept the automatic restart during the installation or you need to restart
it manually later before starting the docker containers.
If you configure HA on XiVO, you have to re-configure postgres to accept connection of XiVO CC
- see PostgreSQL configuration section
By default XiVO CC installation will pre-empt network subnets 172.17.0.0/16 and 172.18.0.0/16
If this subnet is already used, some manual steps will be needed to be able to install XiVO CC.
These steps are not described here.
This diagram is very important and shows the architecture between the different components inside XiVO CC and also interactions
with XiVO PBX components.
Do not use pause on one queue or a subset of queues status, only pause or ready on all queues
Do not activate Call a member already on (Asterisk ringinuse) on xivo queue advanced configuration
When creating a new queue, this queue will not appear immediately in CCAgent and CCManager
until the agent or the manager is not relogged to these applications accordingly.
When deleting an existing queue, this queue will still appear in CCAgent and CCManager
until the Xuc server is not restarted.
All users and queues have to be in the same context
Agent and Supervisors profiles should use the same Presence Group
Agents and Phones should be in the same context for mobile agents
Agents must not have a password in XiVO agent configuration page
All users must have the supervision on the XiVO (IPBX-Users-Edit-Services-Enable supervision checked)
When and agent is disassociated from its user, xuc server has to be restarted.
We strongly advise to not delete any user or agent to keep reporting available for them.
Even so when an agent is deleted, xuc server has to be restarted,
The installation and configuration of XiVO CC (with its XiVO PBX part) is handled by the xivocc-installer package which is available in the repository.
If your server needs a proxy to access Internet, configure the proxy for apt, wget and curl as documented in Proxy Configuration.
The install process consists of three parts:
The first part is to manually run the xivocc_install.sh script to install the dependencies (ntp, docker, docker-compose…) and which will trigger the XiVO CC installation.
The second part is to install the extra package for the chat.
The third part is to install the extra package for the recording.
The installation is automatic and you will be asked few questions during the process:
Before copying the authentication keys, you will be prompted for the XiVO PBX root password.
Enter IP addresses of XiVO PBX and XiVO CC.
XiVO PBX must restart, the question will prompt you to restart during the process or to restart later.
Running the script will install the XiVO CC components via the xivocc-installer package. It is required to restart XiVO PBX during or after the setup process.
The installer will ask whether you wish to restart XiVO PBX later.
Warning
Wizard MUST be passed on the XiVO PBX.
XiVO PBX services will need to be restarted.
The installer will ask whether you wish to restart XiVO PBX during or after the setup process.
Also, check that you have following information:
XiVO PBX root password;
OpenSSH PermitRootLogin set to yes (you could revert to no after installation of XivoCC);
XiVO PBX’s IP address;
XiVO CC DNS name or IP address (the one visible byXiVO PBX);
Number of weeks to keep statistics;
Number of weeks to keep recordings (beware of disk space);
The number of weeks to keep statistics must be higher than the number of weeks to keep recordings.
Recording purging is based on the statistic data, so the statistic data must not be removed before purging recordings.
Launch installation:
./xivocc_install.sh-a2022.10-latest
Silent installation:
if it’s not already existing, set up the xivocc_rsa ssh key and upload it on the xivo:
Also, you MUST pass the variable via the /etc/docker/compose/custom.env.
Warning
Even if you’re installing an edge, XUC_HOST must be the XIVOCC IP at installation time. You’ll have to change it to the edge’s FQDN later
mkdir-p/etc/docker/compose
echo"XIVO_HOST=<IP ADDRESS OF THE XIVO>XUC_HOST=<CC IP>CONFIGURE_REPLY=trueWEEKS_TO_KEEP=<Number of weeks to keep>RECORDING_WEEKS_TO_KEEP=<Number of recording weeks to keep>RESTART_REPLY=true">/etc/docker/compose/custom.env
Launch installation in Silent mode using the flag -s:
The XiVO CC server and the XiVO PBX server must be synchronized to the same NTP source.
Recomended configuration : you should configure the NTP server of the XiVO CC server towards the XiVO PBX.
In our example it means to add the following line in the file /etc/ntp.conf:
By default on XIVO CC elasticsearch is started with 1.5Gb for the JVM.
This may need to be adjusted depending on your setup (mostly depending on the number of calls per day).
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.
After a successful installation, start docker containers using the installed xivocc-dcomp script:
To reinstall the package, it is required to run apt-getpurgexivocc-installer then apt-getinstallxivocc-installer. This will re-run the configuration
of the package, download the docker compose template and setup XiVO PBX.
Purging the package will also remove the xuc and stats users from the XiVO PBX database.
Since Electra version, you MUST install and configure the chat backend to have
the Chat feature working properly.
Installation type:
UC Addon: the chat backend package must be installed on the XiVO PBX with the UC Addon.
CC/UC mono-server: the chat backend package must be installed on your CC/UC server.
CC/UC multi-server: the chat backend package must be installed on the server which hosts the xuc.
You will be asked to give the IP Address of the server hosting the pgxivocc.
Warning
Installing the Chat backend will configure a linux user on the host
with UID 2000. Therefore you should check that no user with UID 2000 (you can do it with command id2000)
is existing on the host before installing the Chat backend.
Warning
XiVO CC containers will be recreated. Therefore you must not install the chat backend
before initialization of all databases in pgxivocc was completed. DB replication to the stats database
must be also completed before installing the chat backend.
