SignageOS Applet Synchronizer

Backend application that serves as a middle man for synchronizing content playback across multiple devices running the SignageOS system.

Requirements

• Node.js 14.x or higher
• npm 6.x or higher

Download and installation

Direct download

npm pack @signageos/applet-synchronizer-public
tar -xzf signageos-applet-synchronizer-public-*.tgz
cd package

NPM package

npm install @signageos/applet-synchronizer-public
cd node_modules/@signageos/applet-synchronizer-public

Start

Linux

export PORT=3000 # Set the port you want to use
npm start
# Or simply
node dist/server.js

Windows

Command Prompt (cmd)

set PORT=3000
npm start
REM Or simply
node dist/server.js

PowerShell

$env:PORT = "3000"
npm start
# Or simply
node dist/server.js

Debug

Linux

DEBUG=@signageos/* node dist/server.js

Windows

Command Prompt (cmd)

set DEBUG=@signageos/*
node dist/server.js

PowerShell

$env:DEBUG = "@signageos/*"
node dist/server.js

How it works

The Applet Synchronizer uses WebSockets to broadcast important information to all connected devices.

Help

For more information, please read the synchronization chapter in our documentation.

For information about client/device-side implementation, see the developers portal. Use the option engine="sync-server" and uri=X.X.X.X:3000 (replace X.X.X.X with your server IP address or hostname).

If you'd like to test with a ready-made applet, use one of our example applets available in Applet Example - Sync Mixed Content. Use the configuration sync_server="X.X.X.X:3000" (replace X.X.X.X with your server IP address or hostname).

If you have any additional questions, please contact our support at [email protected].