SAGE2

Browser based implementation of SAGE. A cluster-based html viewer used for displaying elements across multiple browser windows. Based on Node.js, ffmpeg, poplar, image magic, and other JS libraries.

Install SAGE2

• Install (Windows)
  • Binary Installer Instructions For Windows
• Install (Mac OS X)
• For Linux installation, see the scripts provided:
  • Ubuntu (18.0.4) https://bitbucket.org/sage2/sage2/downloads/SAGE2ubuntu-1804.sh
  • Ubuntu (16.0.4) https://bitbucket.org/sage2/sage2/downloads/SAGE2ubuntu-1604.sh
  • Ubuntu (14.0.4 and up) https://bitbucket.org/sage2/sage2/downloads/SAGE2ubuntu.sh
  • CentOS (7 and up) https://bitbucket.org/sage2/sage2/downloads/SAGE2centos7.sh
  • openSuse (13.x and up) https://bitbucket.org/sage2/sage2/downloads/SAGE2opensuse.sh
• Install (Docker)
• Note: When using multiple computers to run displays, the install instructions need only be performed on one which will host the server. All others need only connect through a browser and access their respective ID based on tile position.

Configure

• Create a configuration file for your display environment
• Save file in <SAGE2_directory>/config
• Select your configuration file
  • Option 1: name your configuration file '<host_until_first_dot>-cfg.json'
    (eg. host = thor.evl.uic.edu, config file is 'thor-cfg.json')
  • Option 2: create a file 'config.txt' in <SAGE2_directory>
    Specify the path to your configuration file in 'config.txt'

Run

• Open Terminal / Cmd
  • cd <SAGE2_directory>
  • node server.js (options: -i interactive prompt, -f <file> specify a configuration file)
• Open Web Browser
  • Google Chrome
    • First time use - install SAGE2 Chrome Extension
  • Firefox
    • First time use - go to about:config and set media.getusermedia.screensharing.enabled to true and add domain(s) for SAGE2 server(s) to media.getusermedia.screensharing.allowed_domains
  • Electron
    • Open a terminal window and navigate to the SAGE2_directory.
    • cd <SAGE2_directory>
    • ./node_modules/.bin/electron electron.js -s http://hostname:port -d 0
    • There are additional flags that can be used:
      • -h, --help output usage information
      • -V, --version output the version number
      • -d, --display <number> Display client ID number (int)
      • -s, --server <string> Server URL (string)
      • -f, --fullscreen Fullscreen (boolean)
      • -n, --no_decoration Remove window decoration (boolean)
      • -x, --xorigin <number> Window position x (int)
      • -y, --yorigin <number> Window position y (int)
      • --width <number> Window width (int)
      • --height <number> Window height (int)
      • --password <string> Server password (string)
      • --hash <string> Server password hash (string)
      • --cache Clear the cache
      • --console Open the devtools console
  • SAGE2 pages
    • Display Client: https://<host>:<port>/display.html?clientID=<ID>
    • Audio Client: https://<host>:<port>/audioManager.html
    • SAGE UI: https://<host>:<port>
    • SAGE Pointer: https://<host>:<port>/sagePointer.html (Allow pop-ups)
• Create a one button SAGE2 launcher for the server and displays

Supported File Types

• Images
  • JPEG
  • PNG
  • TIFF
  • BMP
  • PSD
• Videos
  • MP4
  • M4V
  • WEBM
• PDFs

Configure SAGE2

• Configuration Specification

Launch SAGE2

• Launch (Server & Displays)

Develop for SAGE2

• App Creation Tutorials
• SAGE2 Application API
  • Widgets
  • UI Right click menu
  • Event handler alternative
  • Application Data Sharing
• SAGE2 Unity3D Applications
• SAGE2 Webview Container

Startup Scripts

• Using systemd to launch SAGE2 (Tested on OpenSuse 13.1)

Notice

SAGE and SAGE2 are trademarks of the University of Illinois Board of Trustees (SAGE™ and SAGE2™).