Voice Connector
Voice Connector
-
SSH onto the Debian server on which the Voice connector is installed.
-
Use command
ssh <username>@<server-ip> -
Enter user password and press ENTER.
-
Use command
su -
Enter root password and press ENTER.
-
-
Navigate to the folder where the docker-compose.yml and env.txt files are located for the voice connector.
-
Open the docker-compose.yml file and replace the image tag with 4.10.X.
-
Save and close the file.
-
Open the env.txt file and add the following variables.
-
AUTH_ENABLED=true API_USERNAME=voice_auth API_PASS=pass CLIENT_ID=cim CLIENT_SECRET=secret
-
-
Set the above variables as described:
-
AUTH_ENABLED: true or false depending on whether APISIX authentication is enabled in EFCX. The four settings below are set if this value is true.
-
API_USERNAME: The username created in Keycloak for API authentication.
-
On Keycloak create a user in the Expertflow realm.
-
Assign the admin and default roles, and have Email-Verified option enabled.
-
Assign a non-temporary password to this user as well.
-
-
API_PASS: The password for the above user created in Keycloak for API authentication
-
CLIENT_ID: Should always be cim.
-
CLIENT_SECRET: Found on Keycloak in the cim client.
-
-
Run the command
docker compose up -d -
Confirm that the docker container is running by using the command
docker ps -
Confirm that the container is running correctly by opening the logs with command
docker logs -f containerID
Media Server configuration
Scripts
-
SSH onto the Debian server on which the Voice connector is installed.
-
Use command
ssh <username>@<server-ip> -
Enter user password and press ENTER.
-
Use command
su -
Enter root password and press ENTER.
-
-
Confirm git is installed, and install it if is not.
-
Clone the Media Server scripts repository:
git clone -b 4.10.X https://efcx:RecRpsuH34yqp56YRFUb@gitlab.expertflow.com/rtc/freeswitch-scripts.git -
Navigate to the cloned repository to access the files:
cd freeswitch-scripts -
Move the updated scripts and prompts to their respective folders:
mv cxIvr.lua cx_hangup.lua hangup_event.lua outboundIvr.lua vcApi.lua pcs.lua /usr/share/freeswitch/scripts/ chmod -R 777 /usr/share/freeswitch/scripts/ -
Open the cx_env.lua file for your DNs e.g. for DN 1122 open cx_env.lua.
-
Add the following text under the line with config = {
-
auth_enabled = true auth_realm = "expertflow", client_secret = "1234", client_id = "cim", username = "voice_auth", password = "1234",
-
-
Set the above variables as described:
-
auth_enabled: true or false depending on whether APISIX authentication is enabled in EFCX. The four settings below are set if this value is true.
-
auth_realm: Keep at expertflow.
-
username: Same as API_USERNAME in voice connector.
-
password: Same as API_PASS in voice connector.
-
client_id: Should always be cim.
-
client_secret: Same as CLIENT_SECRET in voice connector.
-
Link Uploader
Link Uploader
-
SSH onto the Debian server on which the Link Uploader is installed.
-
Use command
ssh <username>@<server-ip> -
Enter user password and press ENTER.
-
Use command
su -
Enter root password and press ENTER.
-
-
Navigate to the folder where the docker-compose.yml and env.txt files are located for the link uploader.
-
Open the docker-compose.yml file and replace the image tag with 4.10.X.
-
Save and close the file.
-
Open the env.txt file and add the following variables.
-
AUTH_ENABLED=true API_USERNAME=voice_auth API_PASS=pass CLIENT_ID=cim CLIENT_SECRET=secret
-
-
Set the above variables as described:
-
AUTH_ENABLED: true or false depending on whether APISIX authentication is enabled in EFCX. The four settings below are set if this value is true.
-
API_USERNAME: Same as API_USERNAME in voice connector.
-
API_PASS: Same as API_PASS in voice connector.
-
CLIENT_ID: Should always be cim.
-
CLIENT_SECRET: Same as CLIENT_SECRET in voice connector.
-
-
Run the command
docker compose up --no-start