Note1: Troubleshooting articles are only available in English.

Note2: The Rainbow WebRTC Gateway is available for General Availability for OmniPXC Enterprise and since Monday, October 15 for OXO Connect and OXO Connect Evolution.

This General Availability applies only for OXO Connect & OXO Connect Evolution as "stand-alone" PBX. Do not install the WebRTC gateway on an OXO Connect or OXO Connect Evolution that is networked with another PBX. More details on the topologies will be published soon.

Reminder: Due to a future control on the server side that requires an identifier introduced in this WebRTC gateway version 1.67, existing WebRTC gateways whose version < 1.67 must be upgraded to this new version before October 28.

1 Installation

1.1 Requirements:

• Rainbow users need to be granted with either a Business or an Enterprise licenses.
• OmniPCX Enterprise PBX needs:
• to run with SW version OmniPCX Enterprise 12.1 MD2 (M2.300.21.a) & OmniPCX Enterprise R12.2 (M3.402.13.f).
• to be granted with REX licenses per targeted Rainbow user
• to be connected to Rainbow for the Telephony Services
• OXO Connect PBX needs:
  • to run with SW version OXO Connect R300/054.001
  • to be granted with an AnyDevice Terminal per targeted Rainbow user
  • to be connected to Rainbow for the Telephony Services
  • to have VoIP Channels for the SIP trunk
• A Virtual Machine must be set-up to host Rainbow WebRTC Gateway. The VM software is delivered by ALE and requires a VMWARE 6.0 or later environment. The VM has to meet the following minimum requirements that may still change:
• vCPU: 2
• CPU reservation in MHz: 4800
• vRAM: 2GB
• vDISK: 4 GB
• vNIC: 1 GB
• For OXO Connect you can also host the Rainbow WebRTC Gateway on a standalone PC. Read the dedicated installation guide for more details.

1.2 WebRTC gateway OVF/ISO installation:

1.2.1 Software Download

Since version 1.67 the SW package on ALE Portal contains the OVF files for a VMWARE installation and an ISO file for the installation on a standalone PC. 

The WebRTC Gateway Software is subject to export control laws and you need to fill-in a form to request the access to the software (detailed instructions are on the ALE Business Portal). Today the software is available under OXE R12.1, OXE 12.2, OXO Connect R3.0 and OXO Connect Evolution R3.0.

1.2.2 Installation:

First deploy the OVF file in your vCenter and start the virtual machine (VM) or if connected to an OXO Connect install the ISO file on a standalone PC (installation guide). 

For the configuration login with following credentials on the console:

User=rainbow
Password=Rainbow123

Make sure to change the default rainbow login password. Use the command passwd to change it.

For root commands you must use “sudo”

1.3 WebRTC Gateway configuration

When logged using rainbow account, the configuration is made using the commands mpnetwork [options...] and mpconfig [options...]

mphelp //displays the list of mpXXXXX commands//

mpstart|mpstop|mprestart //start, stop or restart gateway//

mpcheck //checks WebRTC gateway connectivity to Rainbow Cloud//

Note: you can find the mpnetwork and mpconfig commands in the history of the WebRTC gateway, that you can review using Up Arrow Key.

1.3.1 First Installation:

You need first to configure the Network settings then the WebRTC gateway settings.

By default the Rainbow WebRTC Gateway starts using a DHCP based network setting.

Login with the rainbow account to make the configuration.

1.3.1.1 Step 1 - Network configuration

Consult first What Are Rainbow Network Requirements?

The 1st time you have to run the command mpnetwork with the mandatory options IP, NETMASK, GATEWAY and DNS as shown below:

mpnetwork --IP="10.2.3.4" --NETMASK="255.255.255.0" --GATEWAY="10.2.3.254" --DNS="10.2.3.253"

You can also run for this 1st step the mpnetwork command with all options by adding NTP and HOSTNAME

mpnetwork --IP="10.2.3.4" --NETMASK="255.255.255.0" --GATEWAY="10.2.3.254" --DNS="10.2.3.253" --NTP="10.2.3.253" --HOSTNAME="rainbow-mpgw"

optional you can add following options

--HOSTDOMAIN="mycompany.com"
--PROXY="user:pass@10.2.3.252:8000/"

Then the WebRTC gateway will reboot automatically.

You'll find the some details in chapter Configuration Modification.

1.3.1.2 Step 2 - Configure the WebRTC Gateway:

The 1st time you have to tun the command with the mandatory options PBX_DOMAIN and PBXID as shown below:

mpconfig --PBX_DOMAIN="10.2.3.5" --PBXID="PBXa1b1-2wxy-3c3d-6789-4e4f-g556-7h89-10i9"

PBX_DOMAIN= is your OXE/OXO ip address
PBXID= is your OXE/OXO pbxid in Rainbow

If you have configured a proxy in step 1 with mpnetwork you should not configure it again in this step.

You'll find the some details in chapter Configuration Modification.

1.3.1.3 Step 3 - Reboot the server

Then you need to reboot the server with the command sudo reboot.

Once the server has restarted you can run the command mpcheck to check the connectivity to Rainbow Cloud.

1.3.1.4 Config files

Once you have executed both scripts mpnetwork and mpconfig you can check the configuration in following file /etc/rainbow-mp.cfg.

IP="10.2.3.4"
NETMASK="255.255.255.0"
GATEWAY="10.2.3.254"
HOSTNAME="rainbow-mpgw"
HOSTDOMAIN="mycompany.com"
DNS="10.2.3.253"
NTP="10.2.3.253"
LOGLEVEL="info"
JANUSLOGLEVEL="4"
PROXY=""
TURN_SERVER="turn-eu1.openrainbow.com"
TURN_PORT="3478"
PBXID="PBXa1b1-2wxy-3c3d-6789-4e4f-g556-7h89-10i9"
PBX_DOMAIN="10.2.3.5"
RAINBOW_DOMAIN="openrainbow.com"
RAINBOW_HOST="openrainbow.com"

This is a summary of the parameters that will be used to configure the VM and the 3 services of the WebRTC gateway.

/etc/janus/janus.cfg
/etc/otlitemediapillargateway/config.js
/etc/kamailio/kamctlrc

1.3.2 Configuration modification:

Once the 1st installation has been performed you can modify each parameter individually.

1.3.2.1 Network settings

Consult first What Are Rainbow Network Requirements?

In case you need to update the configuration each command can be executed separately

mpnetwork --IP="10.2.3.4" //your new ip address of the VM//
mpnetwork --NETMASK="255.255.255.0"
mpnetwork --GATEWAY="10.2.3.254" //your gateway//
mpnetwork --DNS="10.2.3.253" //your DNS//
mpnetwork --NTP="10.2.3.253"
mpnetwork --HOSTNAME="rainbow-mpgw"

optional

mpnetwork --HOSTDOMAIN="mycompany.com"
mpnetwork --PROXY="user:pass@10.2.3.252:8000/"

you may also use

mpnetwork --FQDN="rainbow-mpgw.mycompany.com"

After the modification reboot the server with the command sudo reboot

1.3.2.2 WebRTC Gateway settings:

In case you need to update the configuration each command can be executed separately

mpconfig --PBX_DOMAIN="10.2.3.5" //your OXE/OXO ip address//
mpconfig --PBXID="PBXxxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx" //your OXE/OXO pbxid in Rainbow//

Note: PBX_DOMAIN can be an FQDN (in this case the DNS used by the WebRTC Gateway must resolve this FQDN)

optional

mpconfig --PROXY="user:pass@10.2.3.252:8000/"
mpconfig --RAINBOW_DOMAIN="domain.yy.zz"
mpconfig --RAINBOW_HOST="host.uu.vv"
mpconfig --TURN_SERVER="turn-abx.openrainbow.com"
mpconfig --TURN_PORT="3478"

TURN server configuration replace abx with:

na1 for TURN server located in America
as1 for TURN server located in Asia
oc1 for TURN server located in Oceania
eu1 for TURN server located in France (default value if not modified)
eu2 for TURN server located in Germany
eu3 for TURN server located in UK

After the modification reboot the server with the command sudo reboot

1.3.2.3 Change network settings to DHCP

run the command:

mpnetwork --IP=dhcp

optional you can add a proxy

mpnetwork --PROXY="user:pass@10.1.2.252:8000/"

After the modification reboot the server with the command sudo reboot

2 PBX Configuration

2.1 OminiPCX Enterprise configuration:

Please consult TC2462.

2.2 OXO Connect / OXO Connect Evolution

Please consult TC2479.

3 Rainbow Configuration:

3.1 Equipement configuration

For the OmniPCX Enterprise or OXO Connect connected to the WebRTC Gateway you'll have to select the option "Activate the WebRTC gateway"

3.2 Users Configuration

Each user needs to be granted with either a Business or an Enterprise license

And the Rainbow account must be associated to his PBX phone

4 Troubleshooting:

for troubleshooting please read the troubleshooting guide