Installation steps

Installation Steps

Internet should be available on the machine where the application is being installed and connections on port 9242 should be allowed in the network firewall to carry out the installation steps.

All the commands start with a #, indicating that root user privileges are required to execute these commands. Trailing # is not a part of the command.

Requirements

• Replay Server for HA

• SQL Server 2019

• Two SIP Trunks for HA

• VRS solution on two separate machines for HA

• EFCX Server (for KeyCloak)

• Docker and Docker Compose

• Git

There are two types of installation: EFCX and Cisco (UCCX & UCCE). For EFCX, most of the steps are not required, as Keycloak, JtapiConnector, and Mixer are not required.

Allow ports in the firewall

If there is an active firewall, allow the following ports.

443/tcp
444/tcp
8088/tcp
5060/tcp (only for Cisco)
16386-32768/udp (only for Cisco)
8021/tcp
1433 /tcp
5432 /tcp


# Additional port to open in case of High Avaliability (HA)
8500
8300
8301 /tcp/udp
8302 /tcp/udp
8303 /tcp/udp
8600 /tcp/udp

Installation Steps

1. Please make sure that the Solution Prerequisites are met for the desired deployment type. 

2. Download the deployment script deployment.sh and place it in the user’s home or any desired directory. This script will:

   1. Delete the recording-solution directory if it exists.

   2. Clone the required files for deployment

3. To execute the script, give it permissions to execute and run it as follows.

   BASH

   $ chmod 755 deployment.sh                  
   $ ./deployment.sh

This command will clone the skeleton project, recording-solution. This recording-solution directory contains all the required files for deployment. It will be cloned in the same place as the deployment script is placed.

Now, our cloning has been completed. Our VRS deployment files and directories have been downloaded. We can proceed to configure it.

4. Follow this guide to install and configure Freeswitch. The recording path in Free SWITCH and in Docker compose volume must be the same.

5. Follow this guide to configure ESL. (for Pause and Resume Recording)

6. Follow this guide to create an application user on CUCM for jtapi-connector.

7. Create a database in SQL Server for VRS with the name vrs and run the SQL script (sqlserver.sql) located in recording-solution/data/scripts. This script will generate the required database tables.

8. Navigate to the recording-solution/docker directory.

9. Only in case of non-HA, open docker-compose-cisco.yml and uncomment the archival-process container. For HA, keep it commented. Save and exit.

10. Open config.env in the same directory and update the environment variables given below.

The below Env variables are only for UCCX.

The following Env variables are only for UCCE.

6. The following Environment variables are for Keycloak.

11. Add the Following environment variables for pause and resume recording.

12. Update the Database environment variables in config.env.

12. To update the self-signed certificates for VRS, get the public authority or domain signed certificate .crt and .key files, name them server.crt and server.key, and replace the files in /recording-solution/config/certificates with these two new files. Names should be the same.

13. Navigate to the recording-solution directory and assign permissions to the install script.

    CODE

    chmod 755 install-cisco.sh  #in case of CISCO
    chmod 755 install-efcx.sh   #in case of EFCX
    chmod 755 install-replay.sh #in case of HA CISCO

14. Perform this step only if Deployment Profile is EFCX.

    1. On the Media Server, run the following command and note the output password:

       CODE

       cat /etc/fusionpbx/config.conf | grep database.0.password

    2. Run the following command and enter the password noted before:

       CODE

       psql -h 127.0.0.1 -p 5432 -U fusionpbx -d fusionpbx

    3. Run this command to create the required database index

       CODE

       CREATE INDEX idx_mykey ON v_xml_cdr USING GIN (json) WHERE json->'variables' ? 'sip_h_X-CALL-ID';

15. Run ./install-efcx.sh for EFCX Or run ./install-cisco.sh for Cisco UCCX and UCCE.

16. Run the following command to ensure all the components are running. 

    CODE

    # docker ps

17. In case of Cisco, go to https : //VRS-IP/#/login to access the application, whereas for EFCX go to https://VRS-IP:444/#/login.

18. For HA-specific deployment, proceed with the following steps.

Copy the Config. env file and paste it in the Recorder 2 VM and Replay Server, as most of the environment variables are the same

19. Follow this guide for the creation of an rsync job on All VMs Recorder 1, Recorder 2, and Replay Server.

20. Go to the replay server add permission to install.sh script and then run ./install-replay.sh.

21. Configure two SIP Trunks on Cisco Call Manager in HA Mode and set priorities for both Machines.

22. Do the following steps for both recorder1 and recorder2.

23. Open recoding-solution/docker/docker-compose-cisco

24. Inside the docker-compose-cisco file, Uncomment the Consul Container.

25. In the container_name variable, set the name as consul1 for Recorder 1 and consul2 for Recorder 2.

26. Add your interface card. This can be found using the ifconfig or ip address command.

- CONSUL_BIND_INTERFACE=ens192   #ens192 or end32

28. In the command section, set the name of the consul in the -node=<any-name> as shown in the code snippet below. This name must be different than the second recorder.

29. Set the -advertise=<Local-Machine-IP> and set -retry-join=<IP-Second recorder> . Keep the other values as it is

#    command: "agent -node=consul-106 -server -ui -bind=0.0.0.0 -client=0.0.0.0 -advertise=192.168.1.106 -bootstrap-expect=2 -retry-join=192.168.1.101"

29. Save changes and exit.

30. Run ./install-cisco.sh

31. Check containers on both recorders using the docker ps command

32. Deploy the Recorder 2 in the same way.

33. Deploy the replay server. For the replay server, just add the config.env file. and run the ./install-replay.sh command.