Versions Compared

Version Old Version 74 New Version 75
Changes made by

ef.confluence

Sikander Hayat

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Installation Steps

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

  2. Download the deployment script

    View file
    namedeployment.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 the execute permissions and execute it. This command will clone the skeleton project for the recording solution. the recording-solution directory contains all the required files for deployment.

    Code Block
    languagebash
    $ chmod 755 deployment.sh
$ ./deployment.sh

  4. Follow step 5 to 8 for deployment with Cisco UCCX or UCCE

  5. Follow this guide to install and configure Freeswitch. The recording path should be /usr/share/freeswitch/cucmRecording

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

  7. Open recording-solution/docker/config.env and update the environment variables given below.

Name

Description

1

VRS_URL

URL of a local machine. example, https: //192.168.1.101 *

2

LOCAL_MACHINE_IP

Local machine IP since it is a non-HA deployment. example 192.168.1.101 *

3

KC_HOSTNAME

Keycloak hostname where keycloak is hosted. e.g 192.168.1.101

4

TZ

Time Zone. e.g Asia/Karachi

5

TRUST_STORE_PATH

/app/ssl/truststore.jks. [keep it same]

6

TRUST_STORE_PASSWORD

Password for the trust store. [Expertflow464]

7

FINESSE_URL

https: //uccx12-5p.ucce.ipcc:8445

86

DIRECTORY_PATH_TO_MONITOR

The path for archival process to monitor, it should be the same path where sessions are kept. e.g /usr/share/freeswitch/cucmRecording/sessions/

97

ARCHIVED_MEDIA_FILES_EXTENSION

mp4 [keep it same]

108

FILE_EXTENSION

wav [keep it same]

119

NO_OF_DAYS

No of days before which all the files will be archived. If set 2, then except for last 2 days from the date and time of service started or triggered all the files will be archived. 

1210

SFTP_HOST

SFTP host IP for archival e.g 192.168.1.106

1311

SFTP_PORT

22

1412

SFTP_USERNAME

Username of the SFTP server e.g expertflow

1513

SFTP_PASSWORD

SFTP password e.g Expertflow464

1614

ARCHIVAL_JOB_INTERVAL

It is a duration that tells the service to trigger again. This value is in hours. For example, if set 24 the service would be triggered after 24 hrs to get the desired job done.

1715

STEAM_DELETION_JOB_INTERVAL_HRS

Time in hours before which all the stream is to be deleted. e.g 24

1816

RETRY_LIMIT

limit to retry in case the connection fails. e.g 2

1917

ARCHIVAL_PROCESS_NODE

active

2018

NO_OF_DEL_DAYS

No of days before which all the streams will be deleted. If set 2, then except for last 2 days from the date and time of service started or triggered all the files will be deleted. 

2119

CISCO_TYPE

Either UCCE or UCCX

2220

ACTIVEMQ_BROKER_URL

Connection URL to Consumer as a Broker e.gtcp://192.168.1.101:61616

2321

ACTIVEMQ_URL

Connection URL for ActiveMQ tcp://192.168.1.101:61616?broker.persistent=true&broker.schedulerSupport=true

2422

ACTIVEMQ_USER

UserName for the ActiveMQ service i.e admin

2523

ACTIVEMQ_PASSWORD

Password for the ActiveMQ service i.e admin

2624

CUCM_APPLICATION_USER_NAME

CUCM User's username that has been created in step 3.

2725

CUCM_APPLICATION_USER_PASSWORD

Password for the CUCM Application User.

2826

CUCM_IP

IP address where CUCM has been Deployed

2927

DEPLOYMENT_PROFILE

Profile that we want to use for backend “CISCO” or “EFCX“

...

  1. Navigate to the recording solution directory and execute the following commands:

    Code Block
    chmod 755 install-cisco.sh
chmod 755 install-efcx.sh

#for UCCX and UCCE run
./install-cisco.sh

    Verify all the containers are up and healthy 

  2. Verify if the keycloak container is healthy (docker ps), if it is on restarting, kill  (docker kill keycloak) and remove (docker rm keycloak) the keycloak container then run ./install.sh. Wait for keycloak container to become healthy.

  3. Set up up keycloak

  4. Once keycloak is set up for Cisco and for EFCX it is already setup, add the below environment variables accordingly in the recording-solution/docker/config.env file.

...

  1. 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.

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

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

    Code Block
    # docker ps

  4. Go to https : //VRS-IP/#/login to access the application.

  5. Configure the SIP trunk to enable CUCM to send SIP events to VRS for call recordings. Two sip trunks should be configured in case of HA. (Not for EFCX)

...