Skip to content

bishopcais/display-worker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

70f058f · Apr 1, 2023
Oct 16, 2019
Apr 1, 2023
Apr 1, 2023
Aug 3, 2022
Nov 8, 2019
Dec 14, 2021
Oct 9, 2020
Oct 16, 2019
Nov 17, 2016
Mar 26, 2020
Mar 26, 2020
Jul 2, 2021
Jul 2, 2021
Apr 1, 2023
Apr 1, 2023
Dec 14, 2021

Repository files navigation

display-worker

The display-worker is an electron based display daemon that can be used to show remotely managed web-based contents. The display-worker exposes an API on RabbitMQ that can be used to open URLs within "windows" and manage them. To make working with the display-worker easier, it is recommended to use the @cisl/io-display plugin for @cisl/io.

Usage

To use the display-worker, first clone the repository:

git clone git@github.com:bishopcais/display-worker.git
cd display-worker
npm install
cp cog-sample.json cog.json

To run it:

npm start

Configuration

To configure the display-worker, you will need to modify its cog.json file. The cog-sample.json file within the repository acts as a starting point, with the full list of options specified below:

{
  "display": {
    "displayName": "required, reference name for this display-worker instance",
    "templateDir": "optional, path to template file, defaults to dist/template",
    "liaison_worker_url": "optional, url for the liaison worker, omit to disable connection"
  }
}