CX Voice Upgrade Guide CX5.1.0 to CX5.2.0

Upgrade of Media Scripts

Clone the Media Server scripts repository:

git clone -b 5.2.0 https://efcx:RecRpsuH34yqp56YRFUb@gitlab.expertflow.com/rtc/freeswitch-scripts.git

Navigate to the cloned repository to access the files:

cd freeswitch-scripts
  • Move the files ending in .lua  to the Media Server scripts folder:

  • mv *.lua /usr/share/freeswitch/scripts
    

Update fsIp in vcApi.lua

vi /usr/share/freeswitch/scripts/vcApi.lua
--Search for fsIp and Replace fsIp = '192.168.1.161' with your actual Media Server Public IP
fsIp = '192.168.1.161'

Save and exit the file by pressing the Esc key, entering:wq and pressing ENTER.

Upgrade of Voice Connector

Voice Connector


  • SSH into the Debian server.

    • Use the command:

      • ssh username@server-ip
        
    • Enter the SSH password and press Enter.

    • Use the command:

      • su
        
    • Enter the root user's password

Container deployment

The voice connector is deployed as a Docker image.

  • Navigate to the existing Voice connector directory

  • cd voice-connector
    
  • Stop the previously running container

  • docker compose down
    
  • Open the file docker-compose.yml.

    • vi docker-compose.yml
      
  • Enter editing mode with the 'I' or 'Insert' keys.

    • Replace the previous tag with the current release tag 5.2.0

      version: "3.8"
      services:
        voice-connector:
          image: gitimages.expertflow.com/freeswitch/ecx_generic_connector:5.2.0
          deploy:
          
          ...
          ...
      
  • Save the file and exit by :

    • Press the Esc key.

    • Enter the phrase:wq to save and exit.

  • Run the command:

    • docker login gitimages.expertflow.com
      
    • Enter your username and password as prompted (make sure that you were granted access to the repository).

  • Within the folder, run the command:

    • docker compose up -d
      
  • Confirm that the new Docker container is running by using the command:

    • docker ps
      
image2023-9-6_12-55-39.png?version=1&modificationDate=1693986938289&cacheVersion=1&api=v2&width=800
  • Confirm that the container is running correctly by opening the logs with the command:

    • docker logs -f containerID
      
image2023-9-6_12-58-15.png?version=1&modificationDate=1693987093716&cacheVersion=1&api=v2&width=700
  • If there are multiple Voice Connectors running, update all of them if needed.

Upgrade of OB Dialer

OB Dialer


  • SSH into the Debian server.

    • Use the command:

      • ssh username@server-ip
        
    • Enter the SSH password and press Enter.

    • Use the command:

      • su
        
    • Enter the root user's password

Container deployment

The OB Dialer is deployed as a Docker image.

  • Navigate to the existing outbound dialer directory

  • cd outbound-dialer
    
  • Stop the previously running container

  • docker compose down
    
  • Open the file docker-compose.yml.

    • vi docker-compose.yml
      
  • Enter editing mode with the 'I' or 'Insert' keys.

    • Replace the previous tag with the current release tag 5.2.0

      version: "3.8"
      services:
        outbound-dialer:
          image: gitimages.expertflow.com/rtc/outbound-dialer:5.2.0
          deploy:
          
          ...
          ...
      
  • Save the file and exit by :

    • Press the Esc key.

    • Enter the phrase:wq to save and exit.

  • Run the command:

    • docker login gitimages.expertflow.com
      
    • Enter your username and password as prompted (make sure that you were granted access to the repository).

  • Within the folder, run the command:

    • docker compose up -d
      
  • Confirm that the new Docker container is running by using the command:

    • docker ps
      
image-20260420-065623.png
Link Uploader


  • SSH into the Debian server.

    • Use the command:

      • ssh username@server-ip
        
    • Enter the SSH password and press Enter.

    • Use the command:

      • su
        
    • Enter the root user's password

Container deployment

The Link Uploader is deployed as a Docker image.

  • Navigate to the existing Link Uploader directory

  • cd recording-link-uploader
    
  • Stop the previously running container

  • docker compose down
    
  • Open the file docker-compose.yml.

    • vi docker-compose.yml
      
  • Enter editing mode with the 'I' or 'Insert' keys.

    • Replace the previous tag with the current release tag 5.2.0

      version: "3.8"
      services:
        recording-link-uploader:
          image: gitimages.expertflow.com/voice-recording-solution/recording-link-activities:5.2.0
          deploy:
            resources:
              limits:
                memory: 1024m
              reservations:
                memory: 256m
          container_name: recording-link-uploader
          env_file:
            - ./env.txt
          volumes:
            - /var/lib/freeswitch/recordings/:/var/lib/freeswitch/recordings/
          command: ["java", "-Xms256m", "-Xmx1024m", "-XX:+UseG1GC", "-XX:MinHeapFreeRatio=10", "-XX:MaxHeapFreeRatio=30", "-jar", "/app/recording-link-activities.jar"]
          restart: no
      
  • Save the file and exit by :

    • Press the Esc key.

    • Enter the phrase:wq to save and exit.

  • Run the command:

    • docker login gitimages.expertflow.com
      
    • Enter your username and password as prompted (make sure that you were granted access to the repository).

  • Within the folder, run the command:

    • docker compose up -d
      
  • Confirm that the new Docker container is running by using the command:

    • docker ps
      

VRS Upgrade Guide (14.7 → 14.7.1)

VRS

1. EFCX Configuration Update

Modify the Docker Compose file to update the vrs apis image to version 14.7.1.

  • File Path: /root/recording-solution/docker/docker-compose-efcx.yml

  • Command: vi /root/recording-solution/docker/docker-compose-efcx.yml

services:
  backend:
    container_name: backend
    image: gitlab.expertflow.com:9242/voice-recording-solution/apis:14.7.1

2. Cisco Environment Update

Apply the same image tag to the Cisco-specific Docker file.

  • Target Image: gitlab.expertflow.com:9242/voice-recording-solution/apis:14.7.1