Welcome to OpenFin Docs

Explore our guides, resources and references for building with OpenFin

Get Started

OpenFin installer

Deployment options introduction

Depending on whether you have OpenFin previously installed you can one of the two options:

OpenFin Installer Generator

The OpenFin Installer Generator streamlines the process of installing and updating the OpenFin Runtime on a users desktop, providing auto update behavior in response to Runtime version changes in an application's manifest file.

The installer is pre-baked only with the application’s manifest URL and is delivered as a zip file containing an installer executable, which can be hosted on any web server. A user opens the .zip file and then double-clicks the .exe to start the installation.

The OpenFin installer performs the following actions:

  • Auto-updates the RVM if necessary
  • Retrieves the application config file
  • Automatically downloads the required Runtime version if it’s not present
  • Installs the desktop/Start menu shortcuts
  • Launches the app

When providing the Desktop Owner with the .zip installer or a URL link, let them know that:

  • Admin rights are not required for installation
  • Signed by OpenFin
  • Copies the relevant application resources into %localappdata%/OpenFin
  • Creates application shortcuts on the Desktop and Start Menu (linked to the application manifest file)

Folder structure

The OpenFin installer creates a base folder structure with full read-write permissions and places the the Runtime Version Manager (RVM), and the OpenFin Runtimes within it. Final folder layout after a typical installation is below. In this case, the install directory is the same as the working directory:

A runtime is contained in the runtime folder. Older versions of the runtime are not overwritten when adding a new version. However, unused versions of the runtime are removed automatically. An application's shortcut is added to the start menu as well as on the desktop. When clicked, the shortcut calls on the Runtime Version Manager (RVM). The RVM then reads the application’s manifest file and starts the application based on it's config URL. To manually launch the config url from your terminal, use -config followed by the app config URL.

OpenFinRVM.exe --config="https://targetapp.com/my/path/appConfig.json"

Shortcuts

The OpenFin installer creates application shortcuts that link the server hosted manifest file with a desktop shortcut or Start Menu item. These shortcuts have a target that takes the following form:

%localappdata%\OpenFin\OpenFinRVM.exe

--config="http://appProvider.com/application/ myApp.json"

For more information on customized shortcuts, contact support@openfin.co.

Run installer silently

This option enables a Desktop Owner to silently run an installer.

Example command line to run the install:

installer.exe --no-ui --do-not-launch

Silent install and no launch

This option enables a Desktop Owner to silently install the the Runtime and prevents the application from launching on install via command line arguments:

--no-ui
--do-not-launch

Example command line to run the install:

OpenFinRVM.exe --do-not-launch --no-ui --config="https://targetapp.com/my/path/appConfig.json"

Protocol handler (fin:// fins://)

For desktops that already have OpenFin, you have the option to use a custom protocol handler to launch OpenFin from within the browser or an email. No downloading of a file is necessary when using this method.

Note

The OpenFin RVM must be installed and registered on the desktop in order for the fin:// or fins:// Protocol Handler to be used. This custom protocol handler will only work from a hyperlink and not from the address bar. (RVM 2.7+)

The fin and fins protocol handlers are registered in the system registry classes root:

HKEY_CLASSES_ROOT\fin and HKEY_CLASSES_ROOT\fins

For desktops that do not have OpenFin installed, one can push the RVM to the desktop and run it one time to register the protocol handler. The command line for registering the fin/fins protocol handler is below:

C:\Users\AppData\Local\OpenFin>OpenFinRVM --config=none --only-self-install

For more information around the installation process, please view our knowledge base or contact support@openfin.co.

Updated 26 days ago


OpenFin installer


Suggested Edits are limited on API Reference Pages

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