Welcome to OpenFin Docs

Explore our guides, resources and references for building with OpenFin

Get Started

Group policy and registry settings

Overview

OpenFin provides desktop owner administrators the ability to customize the Runtime environment to manage controls around specific API features. These controls over the Runtime and RVM (v 2.5.1+) enable application providers to use all API features, but give their customers (on a case by case basis), the option to turn them off via group policy. These additional settings are an extension of the Chromium base Group Policy flags.

OpenFin supports all policies that are managed in Chromium and supported on Windows. For the list of these policies and their settings, refer to the Chrome Enterprise policy list.

We’ve created templates for desktop owners to simplify the process of setting up group policy for users. These can be found in the following repos:

Runtime group policy template RVM group policy template

Locations

There are two main base paths where the RVM will look to read settings keys from, which can exist in both HKEY_CURRENT_USER and LOCAL_MACHINE.

  • Group policy registry base path: Software\Microsoft\Windows\CurrentVersion\Policies\OpenFin\RVM
  • Registry base path: Software\OpenFin\RVM

Key precedence

If the same key value (for example, rvmInstallDirectory) exists in multiple locations, the key value that is actually used is based on the following rules:
HKEY_CURRENT_USER > HKEY_LOCAL_MACHINE > Group policy registry > Registry > App manifest

For example, if the key “rvmInstallDirectory” is set in all possible locations, below is the order in which the value would be selected:

  1. HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Policies\OpenFin\RVM\Settings\rvmInstallDirectory
  2. LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Policies\OpenFin\RVM\Settings\rvmInstallDirectory
  3. CURRENT_USER\Software\OpenFin\RVM\Settings\rvmInstallDirectory
  4. HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\rvmInstallDirectory
  5. Application manifest: "rvmInstallDirectory"
  6. OpenFin default rvmInstallDirectory

OpenFin Group Policy Settings


assetsUrl

Globally sets a URL for retrieving application assets.
Data type: String (REG_SZ)
Expected value: A URL to the server that is hosting the assets.
Default value: https://cdn.openfin.co
Key: HKEY_LOCAL_MACHINE\SOFTWARE\OpenFIn\RVM\Settings\assetsUrl
Value: http://YourAssetServer.com
Result: RVM and Runtime assets are retrieved from your specified asset server as opposed to the OpenFin asset repository.
Example


cleanUnusedRuntimes

Globally determines whether the RVM cleans up runtime and runtime cache folders that are no longer referenced by any installed applications. By default, the RVM does clean up unused runtimes.
Data type: DWORD (REG_DWORD)
Expected value: 0 or 1
Default value: 1 — The RVM cleans up unused runtimes.
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\cleanUnusedRuntimes
Value: 0
Result: Runtime and runtime cache folders are not cleaned up when when no applications reference them.
Example


crashReporterUrl

The endpoint URL to which the RVM sends crash reports.
Date type: String
Expected value: A URL to a server that can accept crash reports.
Default value: https://dl.openfin.co/services/crash-report-v2"`
Key: HKEY_CURRENT_USER\SOFTWARE\OpenFin\RVM\Settings\crashReporterUrl
Value: " http://example.com/crash-reporter"
Result: The RVM sends crash reports to the specified URL instead of to OpenFin's crash report server.


disableShortcutCreation

Whether to globally prevent all applications installed through the RVM from creating shortcuts. The desktop owner can choose to be responsible for shortcut creation.
Data type: DWORD (REG_DWORD)
Expected value: 0 or 1
Default value: 0 — Applications installed through the RVM install their shortcuts.
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\disableShortcutCreation
Value: 1
Result: When an application is installed through the RVM, shortcuts for the application are not created.
Example


enableRuntimeDiagnostics

Whether to enable reporting Runtime diagnostics information to OpenFin. (RVM 4.2.0.35+, Runtime v20+)
Data type: DWORD (REG_DWORD)
Expected value: 0 or 1
Default value: 1
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\enableRuntimeDiagnostics
Value: 0
Result: Once the Runtime closes, the RVM reports diagnostic information about the Runtime session to OpenFin.


lrsUrl

Globally sets the licensing server URL for all applications. The RVM sends all licensing information to the specified server instead of directly to the OpenFin default server.
Data type: String (REG_SZ)
Expected value: A URL to a server that is running the LRS/RDM (a hosted service).
Default value: The licensing URL specified in the application manifest or the OpenFin default.
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\lrsUrl
Result: The RVM sends all licensing information to the specified URL.
Example


maxAppLogFileSizeMB

Specifies the maximum log file size in megabytes for an application-specific log. Note that the RVM uses 1MB = 1048576 bytes. (RVM 4.2.0.35+)
Data type: DWORD (REG_DWORD)
Expected value: A DWORD representing the max app log file size in MB.
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\ApplicationLogging\maxAppLogFileSizeMB
Value: 0x00000400 (1024 MB)
Result: The RVM does not let application logs grow over this size.
Example


maxAppLogFiles

Specifies the maximum number of archived log files for an application that uses application logging.
Data type: DWORD (REG_DWORD)
Expected value: A DWORD representing the maximum number of archived application logs.
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\ApplicationLogging\maxAppLogFiles
Value: 0 (unlimited)
Result: The RVM only keeps the youngest zipped log files and delete the oldest zipped log files, without exceeding the number specified in this setting.
Example


runtimeArgs

Globally add runtime arguments to apply for all applications.
Data type: String (REG_SZ)
Expected value: A string containing any number of desired runtime flags, separated by spaces.
Default value: The runtime arguments specified in the application configuration.
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\runtimeArgs
Value: –user-data-dir=”%localappdata%custom_cache_directory
Result: All applications utilizing the RVM specify –user-data-dir runtime flag when they are launched. This specific runtime flag can be used to set a custom directory where the runtime writes its cache information.
Example


rvmInstallDirectory

The RVM copies itself and operates from this directory. (RVM 2.8+)
Data type: String (REG_SZ)
Expected value: A folder path where you want the RVM to copy itself from.
Default value: %LOCALAPPDATA%\OpenFin
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\Deployment\rvmInstallDirectory
Value: %LOCALAPPDATA%\CustomFolder
Result: If the RVM executes from a different folder, it copies itself to the custom folder and re-runs from there.
Example


runtimeCache

The Runtime writes any cache data here. This is a global setting that overrides any application configuration. (RVM 2.8+)
Data type: String (REG_SZ)
Expected value: A folder path where you want the RVM to write cache data.
Default value: %LOCALAPPDATA%\OpenFin\
Key: \Software\OpenFin\RVM\Settings\Deployment\runtimeCache
Value: %LOCALAPPDATA%\RuntimeCache
Result: The runtime writes its cache data to this folder.
Example


runtimeDirectory

The Runtime binaries are stored here. (RVM 2.8+)
Data type: String (REG_SZ)
Expected value: A folder path where you want the Runtime binaries to be stored.
Default value: %LOCALAPPDATA%\OpenFin\
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\Deployment\runtimeDirectory
Value: %LOCALAPPDATA%\CustomDir
Result: The RVM uses this folder to read and write runtime binaries.
Example


startMenuRootFolder

Globally sets root folder(s) for applications start menu shortcuts.
Data type: String (REG_SZ)
Expected value: A path of custom folders where you want start menu shortcuts to be placed.
Default value: The standard Windows start menu shortcut folder.
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\startMenuRootFolder
Value: custom_folder_name
Result: Start menu shortcuts are placed in “custom_folder_name," for all applications installed through the RVM that specify start menu shortcuts. The custom folder is inside the default Windows start menu folder.
Example


unusedRuntimeExpirationInMinutes

Controls the amount of time after which the RVM removes a downloaded runtime and its corresponding runtime cache folder(s). The RVM keeps track of when the last time a downloaded runtime was launched. After an amount of time based on the value of unusedRuntimeExpirationInMinutes has elapsed since the runtime was last launched, the RVM removes that runtime and its corresponding cache folder(s) the next time the RVM exits. The default value is 0x0000a8c0 (43,200 minutes, or 30 days). Note that this does not apply to runtimes that are not downloaded through the RVM (for example, runtimes that are copied to the /runtime folder via MSI installers or other means). (RVM 3.5.1.0+)
Data type: DWORD (REG_DWORD)
Expected value: A DWORD representing a number of minutes.
Default value: If the desktop owner settings file is not set, every app is allowed.
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\Settings\unusedRuntimeExpirationInMinutes
Value: 0x00043200
Result: The RVM deletes the downloaded runtime after the specified number of minutes after the runtime is launched.
Example


Advanced group policy settings

Use these settings only in specialized circumstances.

protocolHandlerLocation

Purpose: Location where fin and fins links launch the RVM from. Takes precedence over rvmInstallDirectory. Use only in situations where this location needs to be explicitly set, such as when the default location in a virtual environment is periodically emptied.
Data type: String (REG_SZ)
Expected value: Path to the directory containing the RVM that should be launched by fin and fins links.
Default value: Same as rvmInstallDirectory.
Key: HKEY_LOCAL_MACHINE\Software\OpenFin\RVM\SettingsprotocolHandlerLocation
Value: %LOCALAPPDATA%\CustomFolder
Result: When the user clicks a link with a fin or fins protocol, the RVM in the specified folder is launched.


Refer to this page for a complete list of Chromium group policy settings.

Have questions? Get in touch with us at [email protected].

Updated 6 days ago


Group policy and registry settings


Suggested Edits are limited on API Reference Pages

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