Creating path-based web app branding

Your Pexip Infinity deployment uses URL paths (such as /webapp, /webapp2, and /webapp3) to provide users with access to the web app. For each path, you can configure which web app version and branding users are offered when accessing the web app via that path, and you can create and configure additional paths to offer users a variety of differently-branded web app experiences within your environment.

This topic describes how to create and configure web app paths to determine which combinations of web apps and branding are offered in your deployment, in addition to the default paths.

Additional parameters can be appended to the path to allow users to join specific meetings and pass in other information specific to the call being placed. For more information, see Creating preconfigured links to launch conferences via Connect apps.

Prerequisites

You must have already created and uploaded to the Management Node any branding packages to be used.

Note that the branding package content and requirements for each of the three versions of the web app are different, so you may need to upload more than one branding package if you want to create web app paths for more than one branded web app version.

Creating a web app path

To create a specific web app path and apply a branding package to it:

  1. From the Management Node, go to Web App > Web App Paths.
  2. From the bottom of the page, select Add Webapp path.
  3. Complete the following fields:

    Path identifier

    The string that, when appended to the IP address or domain name of a Conferencing Node or reverse proxy, will provide the URL used to access this branded version of the web app.

    For example, if users normally access the web app via webapp.pexample.com and you enter sales here, users will be able to access this branding via webapp.pexample.com/sales

    Permitted characters are a-z, A-Z, 0-9, - and _.

    Description An optional description of this path.
    Web app version The version of the web app accessed using this path.
    Web app bundle

    If you want this alias to direct to a specific revision of the selected Web app version, select the associated software bundle to use.

    If you want this alias to always use the revision of the selected Web app version that is included with Pexip Infinity (rather than any subsequent revision), then use the default Use default web app bundle option. If you select this option, when you upgrade to a later version of Pexip Infinity, this will automatically use the bundle shipped with that later version.

    Branding package

    Select the branding package to use for this path.

    The list of options will include the available branding packages for the selected Web app version.

    If you don't want to apply a branding package and instead want to use the default Pexip branding for the selected web app version, select Use default branding.

    Enabled Determines if the path is enabled or not. Use this setting to test configuration changes, or to temporarily disable specific paths.
    Set as default Select this option if you want users who have entered the address of a Conferencing Node or reverse proxy,either on its own or with /webapp appended, to redirect to this particular path and associated branding. For more information, see Redirecting "/webapp" (or no path)
  4. Select Save.

You can now test the branding by entering the path in your browser and using it to join one of your Pexip Infinity services.

Default paths and default branding

The paths and associated branding that are included by default in your Pexip Infinity deployment, and which of those paths users are redirected to if they either don't specify a path or use /webapp, will depend on whether you are installing a new v31 or later deployment, or upgrading to v31 or later from v30 or earlier.

Redirecting "/webapp" (or no path)

Users access the web app by entering the IP address or FQDN of Conferencing Node or reverse proxy in your deployment, either on its own or with a path appended. You can configure where to redirect users who either do not enter a path or enter the /webapp path (supported by previous versions of Pexip Infinity).

If you don't manually select a default path, the path that /webapp (or no path) redirects to depends on whether this is a new v31 or later Pexip Infinity deployment or an upgrade from v30 or earlier, and if the latter, the setting for the now-deprecated Default web app (v30) or Do not default to the legacy Web App (v29 and earlier) fields under Platform > Global Settings > Connectivity, as follows:

New v31 or later installation

  • /webapp (or no path) redirects to /webapp3

Upgrade from v30

  • If Default web app was set to Always use latest at upgrade or Webapp3, /webapp (or no path) redirects to /webapp3
  • If Default web app was set to Webapp2, /webapp (or no path) redirects to /webapp2
  • If Default web app was set to Webapp1, note that this is no longer supported from v32 onwards. Please contact your Pexip authorized support representative if you still require access to Webapp1.

Upgrade from v29 and earlier

  • If Do not default to the legacy Web App was previously enabled (the default), /webapp (or no path) redirects to /webapp2
  • If Do not default to the legacy Web App was previously disabled, /webapp (or no path) redirects to /webapp1. However, this is no longer supported from v32 onwards. Please contact your Pexip authorized support representative if you still require access to Webapp1.

Manually changing the default path

To see which path is currently used as the redirect, go to the list of web app paths (via Web App > Web App Paths). The currently selected path is indicated by a tick in the Default path column.

To change the path to be used, select the path and then select Set as default.

If none of the paths are set as the default, users who either don't specify a path or use /webapp will be presented with a 404 error.

Default path configuration

Your Pexip Infinity deployment includes the following paths and associated branding. You can delete and edit these default paths, as well as creating new paths.

Path Web app version Branding package name
/webapp1

Webapp1

This is no longer supported from v32 onwards. Please contact your Pexip authorized support representative if you still require access to Webapp1.

Pexip webapp1 branding
/webapp2 Webapp2 Pexip webapp2 branding
/webapp3 Webapp3 Pexip webapp3 branding

Default branding packages

The default branding packages included with Your Pexip Infinity deployment will depend on whether this is a New v31 or later installation or an Upgrade from v30 or earlier.

You can't delete or edit any of these branding packages, but you can download them to use as the basis of your own branding packages.

New v31 or later installation

Every Pexip Infinity deployment includes the following branding packages:

  • Pexip webapp1 branding: containing the default branding for Webapp1
  • Pexip webapp2 branding: containing the default branding for Webapp2
  • Pexip webapp3 branding: containing the default folder structure for Webapp3 branding files.

Upgrade from v30 or earlier

Each upgraded Pexip Infinity deployment includes the branding packages listed above for a New v31 or later installation. In addition, if your previous deployment included custom branding for one or more web apps, you'll also have the associated branding packages listed below.

Note that these additional branding packages will not initially be associated with any web app path; if you wish to continue to use this branding in your deployment you'll need to either apply the package to the relevant default path (replacing the default branding for that path), or create a new path and apply the branding package to it.

  • webapp1 custom branding: containing your previous custom branding for Web app 1
  • webapp2 custom branding: containing your previous custom branding for Web app 2
  • webapp3 custom branding: containing your previous custom branding for Web app 3