Advanced Connect app branding and customization

Most customization requirements for the Connect apps can be implemented by using the Pexip branding portal to generate a package of branding files and then applying that branding by uploading the branding package to the Management Node (see Customizing and branding the Connect apps).

However, for advanced customization requirements you may need to make manual changes to the branding files, or you may want to host the customized web app files on a reverse proxy or external web server instead of on the Pexip Infinity Conferencing Nodes.

This topic covers the alternative methods for hosting the customized web app, and how to manually customize both the Pexip Connect for Web (Webapp3) and the previous (Webapp2) versions of the Connect web app. (For information on customizing the legacy Webapp1, see our v29 documentation).

If you have installed additional web app software bundles for either version of the Connect web app, the customization applies to all revisions.

Note that manual configuration requires knowledge of core web-design technologies such as HTML, JavaScript and CSS.

Hosting the customized web app

There are two methods for hosting the customized Connect web app, either:

  • on the Conferencing Nodes (via an upload on the Management Node), or
  • on an external web server or reverse proxy.

Hosting on the Conferencing Nodes

This is the standard method for applying branding to the Pexip Infinity platform — it applies a generic customization for all web app users. It involves uploading a branding package to the Management Node which then automatically pushes those changes out to all Conferencing Nodes, from where those customizations are served to all web app users.

Branding customizations that are applied to each Connect web app via the Management Node will apply to all revisions of that web app, and will persist over upgrades to subsequent versions of Pexip Infinity software (although you may need to adapt the customization to cater for any new features when upgrading to a new major release).

For this hosting method, we recommend using the Pexip branding portal to configure the branding requirements for the Connect web app and to generate a ZIP file suitable for uploading to the Management Node.

Hosting on an external web server or reverse proxy

This hosting method involves downloading a copy of the entire web app from the Management Node and uploading it onto an external web server or reverse proxy (e.g. the Pexip Reverse Proxy) and serving it from that server. This method allows you, for example, to host multiple different branding customizations under different URLs on those external web servers or reverse proxies.

Downloading the Connect web app files

To download a copy of the Connect web app:

  1. From the Management Node, go to Services > Web App Customization.
  2. From the Download Web app section, use the drop-down menu to select the version of the webapp you want to host externally, and select Download.

A .ZIP file containing the files for the selected webapp is downloaded to your local machine. These files are in a webapp3/ or webapp2/ (as appropriate) directory.

If you are hosting the web app on an external web server or reverse proxy, this whole directory tree should now be copied over to the other server.

Uploading branding files

As you cannot use the Management Node to upload your customized client files when hosting on an external web server or reverse proxy, you must manually upload them.

  • For Webapp3, the branding files must be uploaded to a branding folder directly under the webapp3/ directory. You must create the branding folder if it does not already exist.

    See Manually customizing Pexip Connect for Web ("Webapp3") below for details of the files that you can include in the branding folder.

  • For Webapp2, the branding files must be uploaded to a custom_configuration folder directly under the webapp2/ directory. You must create the custom_configuration folder if it does not already exist.

    See Manually customizing "Webapp2" below for details of the files that you can include in the custom_configuration folder.

Note that:

  • For Webapp2, if you want to customize the settings you must place your settings.json file in the custom_configuration directory along with your other customized files.
  • When hosting the web app on an external web server, you must supply a settings.json file and change the serverAddress variable to point to a Conferencing Node e.g. "serverAddress": "conferencingnode1.example.com". You can only specify one Conferencing Node. This modification is not required if you are hosting the web app on a reverse proxy as it will typically already be configured to forward requests to your Conferencing Nodes.

Maintaining customizations when upgrading Pexip Infinity

If the web app is being hosted on an external web server or reverse proxy, the copy of the web app must be upgraded manually whenever the Pexip Infinity installation is upgraded or you update the web app software bundle. You should migrate the existing customized branding directory (Webapp3) or custom_configuration directory (Webapp2) on the external web server or reverse proxy onto the new version:

  1. Backup the branding / custom_configuration directory on the external web server or reverse proxy containing your current customizations.
  2. Upgrade your Pexip Infinity deployment, or install the software bundle for a new webapp version.
  3. Download the upgraded web app files as described in Downloading the Connect web app files.
  4. Replace the contents of the branding / custom_configuration directory with your previously customized contents.
  5. Check if you need to add any more customizations to support any new features.

    When a new version the web app includes new features, any new customizable elements are added to the default versions of the files in the branding / custom_configuration directory that is shipped with the new software. Therefore, after an upgrade you should compare your customized versions of these files with the new default versions, to see if any text, styles, colors or resource files should be adjusted.

More information

Participant avatars cannot be branded via the web app, but they can be controlled by using external policy or by configuring user records. For full details about how to integrate Pexip Infinity with an external policy server, see Using external and local policy to control Pexip Infinity behavior.

In addition to customizing the appearance of the Connect web app, you can also use themes to change the voice prompts and images provided to participants when they are accessing a Virtual Meeting Room, Virtual Auditorium or Virtual Reception.

If any further information on customizing Pexip Infinity is required, please contact your Pexip authorized support representative.