Setup Instructions

Setup

Setting up a display to be an openframe is fairly easy (and we will continue to make it easier!).

Dependencies

Make sure you have Node.js installed.

On Linux, install chromium. For the Raspberry Pi running Debian:

$ sudo apt-get install chromium

You can also use Chromium on the mac if you want -- download the Chromium app and put it in your Applications directory. Then you can use the -c flag to start the app in Chromium (it will open in kiosk mode on a new desktop).

Installation

From the command line, clone this repo and cd into the root of the project.

$ git clone https://github.com/OpenFrameProject/OpenFrame-NodeClient.git
$ cd OpenFrame-NodeClient

Install the npm dependencies.

$ npm install

You should now be able to run the client (see Usage).

Usage

$ node frame.js -u username -f framename [-d domain] [-c] [-r]

As an example, to start up the frame for user jonwohl, with a server at openframe.io:

$ node frame.js -u jonwohl -f Home -d openframe.io

The presence of the -c flag will force the system to try to open the frame using Chromium instead of whatever the default browser is. At present, on linux Chromium is a required dependency, and will be used regardless of the -c flag.

The presence of the -r flag will reset the frame, causing the server to treat it as if it is an entirely new frame.