1 Installation

1.1 Requirements:

• Rainbow users need to be granted with either a Business or an Enterprise licenses and a mandatory Enterprise License when connected to a 3rd Party PBX.
• OmniPCX Enterprise PBX needs:
• to run with SW version OmniPCX Enterprise from R12.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
• 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 or on Hyper-V. 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

• OXO Connect PBX needs:
  • to run with latest OXO Connect SW version (at the date of publication of this article R310/017.001)
  • or to run at least R400/507.002 to use an OCE Front End as WebRTC gateway
  • 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
• For OXO Connect you can also host the Rainbow WebRTC Gateway on a standalone PC. Read the dedicated installation guide for more details. Or on an OCE WebRTC Front End (OCE FE) which is an OCE hardware running only the WebRTC Gateway component. Read the dedicated article for OCE FE configuration through Rainbow.

Details about the the Rainbow offer connected to a OmniPCX Enterprise or OXO Connect/OXO Connect Evolution can be found in following Technical Business Engine presentation.

• 3rd party PBX needs:
  • to run with with latest version of Rainbow CTI & Media bridge
  • to be connected to Rainbow for the Telephony Services by the the CTI & Media bridge
  • to have a SIP trunk connected with the CTI & Media bridge
  • See Section CTI & Media bridge for other requirements and supported PBXs

1.2 WebRTC gateway OVF/ISO installation:

1.2.1 Software Download

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

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//

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 (DHCP has only to be used with OXO Connect Zero Touch).

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="http://user:pass@10.2.3.252:8000/"
or
--PROXY="http://10.2.3.252:8000/"

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 //
For 2 DNS use following command mpnetwork --DNS="10.2.3.253","10.2.3.252"
mpnetwork --NTP="10.2.3.253"
mpnetwork --HOSTNAME="rainbow-mpgw"
mpnetwork --IP=dhcp // if you want to switch IP config to DHCP mode (only with OXO Connect Zero Touch) //

you may also use

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

1.3.1.2 Step 2 - Configure the WebRTC Gateway:

The 1st time you have to run 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

optional you can use FQDN instead of IP Addresses

mpconfig --RAINBOW_DOMAIN="domain.yy.zz"
mpconfig --RAINBOW_HOST="host.uu.vv"

1.3.1.3 Step 3 - Check configuration

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="GEOIP"
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.3 Change network settings to DHCP (Only with OXO Connect Zero Touch)

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