...
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 |
| 8 | 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/ |
| 9 | ARCHIVED_MEDIA_FILES_EXTENSION | mp4 [keep it same] |
| 10 | FILE_EXTENSION | wav [keep it same] |
| 11 | 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. |
| 12 | SFTP_HOST | SFTP host IP for archival e.g 192.168.1.106 |
| 13 | SFTP_PORT | 22 |
| 14 | SFTP_USERNAME | Username of the SFTP server e.g expertflow |
| 15 | SFTP_PASSWORD | SFTP password e.g Expertflow464 |
| 16 | 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. |
| 17 | STEAM_DELETION_JOB_INTERVAL_HRS | Time in hours before which all the stream is to be deleted. e.g 24 |
| 18 | RETRY_LIMIT | limit to retry in case the connection fails. e.g 2 |
| 19 | ARCHIVAL_PROCESS_NODE | active |
| 20 | 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. |
| 21 | CISCO_TYPE | Either UCCE or UCCX |
| 22 | ACTIVEMQ_BROKER_URL | Connection URL to Consumer as a Broker e.g |
| 23 | ACTIVEMQ_URL | Connection URL for ActiveMQ |
| 24 | ACTIVEMQ_USER | UserName for the ActiveMQ service i.e admin |
| 25 | ACTIVEMQ_PASSWORD | Password for the ActiveMQ service i.e admin |
| 26 | CUCM_APPLICATION_USER_NAME | CUCM User's username that has been created in step 3. |
| 27 | CUCM_APPLICATION_USER_PASSWORD | Password for the CUCM Application User. |
| 28 | CUCM_IP | IP address where CUCM has been Deployed |
| 29 | DEPLOYMENT_PROFILE | Profile that we want to use for backend “CISCO” or “EFSWITCH“ |
| 30 | EFCX_FQDN | URL of the EFCX |
Below Env variables are only for UCCX
...
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
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.
Once keycloak is set up , update for Cisco and for EFCX it is already setup, add the below environment variables accordingly in the
Namerecording-solution/docker/config.envfile.
Names | Description | |
|---|---|---|
1 | KEYCLOAK_REALM_NAME | For Cisco Realm name created in step 4 of keycloak setup For EFCX add the realm name from EFCX keycloak |
2 | KEYCLOAK_CLIENT_ID | For Cisco Keycloak client id from step 6 of keycloak setup For EFCX add the client id from EFCX keycloak |
3 | KEYCLOAK_CLIENT_SECRET | For Cisco keycloak client secret from step 8 of keycloak setup For EFCX add the client secret from EFCX keycloak |
4 | KEYCLOAK_PERMISSION_GROUP | For both keep it “AGENT_GROUP“ |
5 | EFCX_FQDN (Only for EFCX) | URL of the EFCX |
Names | For Cisco | For EFCX | |
|---|---|---|---|
1 | KEYCLOAK_REALM_NAME | Realm name created in step 4 of keycloak setup | Realm name from EFCX keycloak |
2 | KEYCLOAK_CLIENT_ID | Keycloak client id from step 6 of keycloak setup | KeyCloak client id from EFCX keycloak |
3 | KEYCLOAK_CLIENT_SECRET | keycloak client secret from step 8 of keycloak setup | Add the client secret from EFCX keycloak |
4 | KEYCLOAK_PERMISSION_GROUP | AGENT_GROUP |
...
AGENT_GROUP | |||
5 | EFCX_FQDN (Only for EFCX) | - | URL of the EFCX |
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.
Run ./install-efcx.sh for EFCX Or run ./install-cisco.sh for Cisco UCCX and UCCE.
Run the following command to ensure all the components are running.
Code Block # docker psGo to https : //VRS-IP/#/login to access the application.
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)