Vitxi – VitalPBX Wiki

Introduction

admin — Mon, 04 Dec 2023 16:53:04 +0000

VitXi WebRTC is a platform that integrates with VitalPBX in a transparent manner, and allows to have the following services:

Audio Calls
Video Calls
Screen Sharing

SIP Chat (Chat between VitXi and SIP Users)
SMS Chat
Chat between VitXi Users

Voice Notes
Emojis
File Sharing
Image Sharing

Graphic Voice Mail Interaction
Call Recordings Viewer
Prescence
Call History
Contact List
And Much More!

VitalPBX Server Preparations

admin — Mon, 04 Dec 2023 16:53:51 +0000

For VitXi WebRTC to work perfectly, it is necessary to have a valid FQDN to assign it security certificates. Coming up, we will show you the steps to follow once we have VitalPBX installed on our server with a valid domain.

Install VitXi

admin — Mon, 04 Dec 2023 16:56:06 +0000

Go to Admin > Add-Ons > Add-Ons and select VitXi and install it. With this we guarantee ourselves at least two free licenses with the Community Version of VitalPBX to try out VitXi WebRTC.

Create a certificate and enable HTTP

admin — Mon, 04 Dec 2023 17:04:56 +0000

Remember that it is necessary to have a valid FQDN and that our VitalPBX server must have a valid certificate.

It is also very important that the host name of the server matches the FQDN that we are using to generate the Let’s Encrypt certificate, so first you must go to Admin/Network/Network Settings and configure the Hostname as shown below.

Now we are going to configure the certificate for which we are going to Admin/System Settings/Certificates.

Afterwards, go to Admin > System Settings > HTTP Server, and force HTTPS connection and select the certificate created previously.

Now go to Settings > PBX Settings > Mini HTTP Server and configure it as shown below. You must select the certificate we have created. Remember to save and Apply Changes. We do this so that VitXi WebRTC PJSIP WebSocket can communicate with VitalPBX.

WebRTC Profile Settings

admin — Mon, 04 Dec 2023 17:12:49 +0000

Go to SETTINGS > Technology Settings> Device Profiles: click on the icon the list of profiles will be displayed:

Select the default WebRTC Profile and verify that the settings are as follows:

Save and Apply Changes.

RTP Settings

admin — Mon, 04 Dec 2023 17:14:55 +0000

Go to CONFIGURATION > PBX Configuration > RTP Configuration and make the following settings:

ICE Support: Yes

ICE Host Settings: This section will allow you to define which IP addresses will be exposed during ICE negotiations. This is commonly used when your PBX server is behind a one-to-one NAT.

Save and Apply Changes.

Firewall Settings

admin — Mon, 04 Dec 2023 17:23:11 +0000

Now, let’s verify that ports 8088, 8089 “Asterisk HTTP Daemon” and 6001 “VitXi WebRTC” are enabled in the firewall services and rules, for them we enter the following path: “Admin/Firewall/Services”

And “Admin/Firewall/Rules”

Note: in case you have another firewall, you must enable the ports mentioned above.

Create a VitXi Extension

admin — Mon, 04 Dec 2023 17:25:13 +0000

Go to PBX > Extensions > Extensions and create an extension with the following parameters:

Technology, PJSIP
Profile, Default WebRTC Profile
WebRTC Client, Yes

Save and Apply Changes.

VitXi WebRTC

admin — Mon, 04 Dec 2023 17:27:29 +0000

VitXi WebRTC is a full web application that integrates with VitalPBX and communicates through the PJSIP protocol over WebRTC.

Installation

admin — Mon, 04 Dec 2023 17:30:39 +0000

VitXi 4.x works with VitalPBX 4 and onwards. To install VitXi WebRTC it is necessary to go to the Add-On module (Admin > Add-Ons > Add-Ons) and press the green install button next to it. After a couple of minutes, the installation would be done, and you can proceed to its URL (http://IP-ADDRESS/VitXi) and proceed with the installation wizard. You can press VitXi’s name on the Add-Ons module to quickly go to this URL.

Now, we will see the installation wizard that will guide us through the final steps for configuration.

a.- Database Settings:

Database User, MySQL user, if we are installing on the same server as VitalPBX, you can leave the username ‘root’ and blank password. Else, you will need to create a new MariaDB user to access remotely.
Database Password, if we are installing on the same server as VitalPBX, the root user does not have a password. When accessing remotely, you must create a new username and password in MariaDB.

b.- PBX Settings:

Host, if we are installing on the same server as VitalPBX, it is recommended to leave this field as localhost. Else, we must input the host or remote IP Address.
Port, if our server has a valid certificate and all the requests are redirected to HTTPS, we must configure port 443. If we are not using HTTPS, we configure port 80. If we are accessing the PBX remotely, remember to open these ports on the firewall.
Application key, if the VitXi is located on the same server as VitalPBX, it is not necessary to generate an API key since it will be generated automatically. If VitXi is installed on a different server to VitalPBX you will need to generate an API key under Admin > Admin > Application Keys. You then copy it and paste it here.

c.- User Setup:

Name, full name for the administrator user in VitXi.
Username, is the administrator username to use in VitXi, usually ‘admin.’
User Password y Password Confirmation, admin user password.
Time zone, here you choose a default time zone.

d.- Enter the Username and Password previously created.