OpenFin

Hosting Runtimes, RVMs, and Other Assets

Overview

By default the RVM resolves release channels, downloads runtimes and newer RVMs from OpenFin’s servers. The RVM can optionally be configured through your application configuration to pull these assets from your own servers. This can be achieved by specifying an “assetsUrl” within your application configuration.

Default ”assetsUrl“ example

By default, the RVM uses OpenFin’s server as its “assetsUrl”, which is https://cdn.openfin.co/release/. If an application is being installed which does not specify an “assetsUrl”, OpenFin’s server is used to resolve release channels, download runtimes and newer RVMs.

For example, if your application is using the “stable” runtime, https://cdn.openfin.co/release/runtime/stable is used to determine the specific runtime version, and that file is a text file containing a version like “8.56.27.75”. The RVM uses this information to download the actual runtime binary from https://cdn.openfin.co/release/runtime/8.56.27.75.

Release channels should not be used in production, especially if you do not have control over the assetsUrl.

If a Desktop Owner specifies a valid “assetsUrl” in the DesktopOwnerSettings or Group Policy, then that “assetsUrl” will be used as the base portion of the URL instead of the OpenFin default, https://cdn.openfin.co/release/.

RVM Assets Server Setup

The RVM expects the server located at “assetsUrl” to have a similar file structure to the following:

  • x32 Bit | rootFolder/runtime/version
  • x64 Bit | rootFolder/runtime/x64/version

Example

RVM Structure

  • rootFolder/rvm/latestVersion

Runtime

  • Every file with a version in the name represents an extensionless zip of a runtime version.
  • The other files are extensionless text files that contain a mapping to a version. For example, the content of alpha can be: “8.56.27.75”.
  • When you access a release channel, the RVM resolves the version and then tries to download the actual file.
  • 8.56.30* + will try to download x64 Bit versions by default.

RVM

  • latest is an extensionless zip file that contains the latest RVM version.
  • latestVersion is an extensionless text file that lists the version number.
  • If the latest version is greater than the current one, the RVM performs an auto update.

You can obtain all the files from our versions page.

To set the assets server, add a new property to your app config:

{
      "assetsUrl" : "http://yourserver.com/rootFolder/"
}

Here is another example of an app config that is using a test webserver hosted at “localhost” on port 5000:

{
      "assetsUrl": "http://localhost:5000/"
}

The RVM will construct a URL to determine which RVM version is the latest by appending “/rvm/latestVersion” to the “assetsUrl”. Then if necessary it will construct a URL to download the latest RVM by appending “/rvm/latest” to “assetsUrl”.

Have questions? Get in touch with us at support@openfin.co.

Hosting Runtimes, RVMs, and Other Assets


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.