openfin-launcher

Deprecated!

This library has been deprecated, please use the launch functionallity in the js-adapter library.

OpenFin-Launcher

OpenFin-Launcher is a Node.js module that automates the downloading and launching of the OpenFin Runtime. This module assumes you have an application config file. You can read up on application config options in the OpenFin config file API docs, or generate it automatically with the openfin-config-builder.

Dependencies

Windows

• Node.js v0.10 or higher

Mac

• Node.js v0.10 or higher
• OpenFin Version 6 or higher

Linux

• Node.js v0.10 or higher
• OpenFin Version 6 or higher
• unzip part of distro or obtained via package manager (apt-get, pacman, etc...)

Getting Started

$ npm install --save openfin-launcher

Usage

var openfinLauncher = require('openfin-launcher');

openfinLauncher.launchOpenFin({
        //Launch a hosted application
        configPath: 'http://localhost:5000/app.json'
        //Or a file path
        //configPath: 'C:/helloWorld/app.json'
    })
    .then(function() {
        console.log('success!');
    })
    .fail(function(error) {
        console.log('error!', error);
    });

//you can also specify the location of the OpenFin Runtime rvm and the download url
openfinLauncher.launchOpenFin({
        configPath: 'http://localhost:5000/app.json',
        rvmPath: 'C:/helloWorld/OpenFinRMV.exe',
        rvmUrl: 'https://cdn.openfin.co/release/rvm/latest'
    })
    .then(function() {
        console.log('success!');
    })
    .fail(function(error) {
        console.log('error!', error);
    });

Options

configPath

Type: String

Default Value: ''

OpenFin Application Configuration file path as described in the OpenFin config file API docs.

Examples:

'http://localhost:3000/app.json'
'C:/helloWorld/app.json'
'/home/userx/app.json'

rvmPath

Type: String

Default Value: path.resolve('OpenFinRVM.exe');

OpenFin RVM location, if not found at the specified path the latest version will be downloaded.

rvmUrl

Type: String

Default Value: https://cdn.openfin.co/release/rvm/latest

Location to the OpenFin RVM downoad URL, if the OpenFin RVM is not found this URL will be used to download the binary.

License

The code in this repository is distributed under the Apache License, Version 2.0

However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin's Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the links listed below or just email us at [e-mail] with questions.

Copyright 2018-2019 OpenFin

https://openfin.co/developer-agreement/

https://openfin.co/licensing/