Versions Compared

Key

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

...

Code Block
443/tcp
8088/tcp
5060/tcp (only for Cisco)
16386-32768/udp (only for Cisco)

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.

...

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

    Code Block
    chmod 755 install.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 keycloak

  4. Once keycloak is set up, update the below environment variables in the recording-solution/docker/config.env file.


    NameDescription
    1KEYCLOAK_REALM_NAMERealm name created in step 4 of keycloak setup
    2KEYCLOAK_CLIENT_IDKeycloak client id from step 6 of keycloak setup
    3KEYCLOAK_CLIENT_SECRETKeycloak client secret from step 8 of keycloak setup
    4KEYCLOAK_PERMISSION_GROUPKeep it same
  5. 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.

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

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

    Code Block
    # docker ps
  8. Go to https : //VRS-IP/#/login to access the application.

  9. 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)

...