{% hint style="success" %} This app can also work in a fully air-gapped environment. If your workspace is subscribed to any of Rocket.Chat's premium plans, follow the Air-gapped App installation guide, and continue with the configuration instructions below. {% endhint %}
Pexip is a purpose-built video communication platform that empowers organizations to transform their operations with video conferencing. Pexip’s technology provides a customized solution with data privacy and business continuity features for secure spaces. Pexip offers both self-hosted and as-a-service deployment options for enterprise video conferencing.
The integration between Rocket.Chat and Pexip enables secure and compliant communication that is ideal for organizations operating within strict regulatory requirements for internal and external communications, such as government, financial services, healthcare, and other sectors.
Key features of the Rocket.Chat - Pexip integration
- Initiate calls from Rocket.Chat directly without switching tools.
- Record and list call details to check users who joined the call.
- Maintain a record of the call history.
In this guide, let's take a look at the underlying architecture of the integration and the app configuration steps.
This integration is made possible by connecting Rocket.Chat with Pexip Infinity through its external policy API. The Pexip app in Rocket.Chat acts as a relay between the two platforms. Rocket.Chat users initiate a video call to a Pexip conferencing node and trigger an external policy request to Pexip. The policy server creates a single-use Virtual Meeting Room (VMR) and responds with the meeting parameters. This VMR is made available in the Rocket.Chat room for its duration.
{% hint style="info" %} Ensure that the Rocket.Chat external policy server can connect to the Pexip Infinity Conferencing Nodes over HTTPS on port 443. {% endhint %}
Rocket.Chat Pexip Architecture
For a complete setup, here are some requirements you need:
- A workspace subscribed to any of Rocket.Chat's premium plans.
- A Pexip infinity server deployed with:
- Valid certificates and intermediate certificates.
- A suitable network routing between Rocket.Chat and Pexip Infinity
- Only one location for each Rocket.Chat workspace, but that location can contain multiple Conferencing Nodes.
To download the Pexip app, follow these steps:
- Go to Administration > Apps > Marketplace.
- Search for the Pexip app and click Install.
- Accept the required permissions.
To configure the Pexip app on your Rocket.Chat workspace, follow these steps:
- Confirm that the app is enabled in your workspace.
- Configure the Pexip server with a remote policy to make service configuration requests before connecting with Rocket.Chat.
- On the Pexip App Info screen, go to Details.
- Copy the policy server URL (
GET policy/v1/service/configuration) and update the Pexip settings. - Copy the POST events URL and add it to the Events Sink on your Pexip server.
{% hint style="info" %} The events sink informs the workspace when a call on Pexip Infinity has ended. This way, the call message block on your workspace is updated with the appropriate call status. {% endhint %}
- On the Pexip App Info screen, go to Settings. Update the Base URL with the URL of your running Pexip server.
- Click Save Changes.
Additional settings' details are as follows:
| Field | Description |
|---|---|
| Base URL | The URL where Pexip is running. |
| API Username | The API username to use for authenticated calls. If specified, Rocket.Chat will ignore any API calls that do not include this username and password. |
| API Password | The password to use along with the API Username. |
| Theme Name | Name of the Pexip theme to be used on Rocket.Chat calls. On Pexip Infinity's settings, you can configure different UI themes to use for your calls. If you want to use a specific theme for calls initiated by Rocket.Chat, enter the theme name in this field. |
| Lock Conferences | Whether conferences should be locked on creation. When enabled, call owners must accept each participant. |
| Allow multiple concurrent calls on the same room | Enable to allow the creation of multiple conference calls in the same room. When disabled, Rocket.Chat will only create one Pexip Conference per room and re-use it for every new call. Users can then connect to the meeting using the room's internal name. |
| Participant name overlay text | Enable to allow participant names or aliases to show at the bottom of a video in a conference call. |
| Meeting layout | Select the meeting layout from the drop-down menu. This determines how the participants are displayed in the meeting room. This does not limit the total number of call participants. |
| Static Host Pin | A pin code to identify meeting hosts. Leave empty to generate a new unique pin for every meeting. |
| Static Guest Pin | Set a pin code to grant meeting access to guests. Leave empty to generate a new unique pin for every meeting. |
To configure the Pexip video conference on your workspace, follow these steps:
- Go to Administration > Settings > Conference Call.
- Select Pexip as your Default Provider.
- Enable or disable the call option in DMs, public channels, private channels, and teams as per your needs.
- Click Save changes.
The Pexip app is successfully configured on your server.
After successfully installing and configuring the Pexip app, you can initiate a secure Pexip call inside any Rocket.Chat room by using the slash command /pexip or the call icon in the room header.
When you use the /pexip command, a new Pexip Virtual Meeting Room (VMR) is created, and a link is made available in the room for users to use and Join call. On joining the call, users are prompted to provide their details and grant permission for camera and microphone usage. The list of users joining the VMR can also be seen within the Rocket.Chat room.
Follow the conference call user's guide to start using the app.