README.md 1.76 KB
Newer Older
Thomas Marrinan's avatar
Thomas Marrinan committed
1
SAGE2
tmarrinan's avatar
tmarrinan committed
2 3 4
=======

Browser based implementation of SAGE. A cluster-based html viewer used for displaying elements across multiple browser windows.
tmarrinan's avatar
tmarrinan committed
5

tmarrinan's avatar
tmarrinan committed
6
##### Dependencies #####
Thomas Marrinan's avatar
Thomas Marrinan committed
7
* node.js
tmarrinan's avatar
tmarrinan committed
8 9
* ffmpeg
* poppler
10
* imagemagick
tmarrinan's avatar
tmarrinan committed
11

tmarrinan's avatar
tmarrinan committed
12
##### Install #####
13 14 15 16
* [Windows Install](https://bitbucket.org/sage2/sage2/wiki/Install%20(Windows))
* [Mac OSX Install](https://bitbucket.org/sage2/sage2/wiki/Install%20(Mac%20OSX))
* [OpenSUSE Install](https://bitbucket.org/sage2/sage2/wiki/Install%20(openSUSE))
* [Ubuntu Install](https://bitbucket.org/sage2/sage2/wiki/Install%20(Ubuntu))
tmarrinan's avatar
tmarrinan committed
17

tmarrinan's avatar
tmarrinan committed
18
##### Configure #####
19
* Create a [configuration file](https://bitbucket.org/sage2/sage2/wiki/Configuration) for your display environment
20
* Save file in <SAGE2_directory>/config
tmarrinan's avatar
tmarrinan committed
21
* Select your configuration file
22
    * Option 1: name your configuration file '<host_until_first_dot>-cfg.json'  
23 24 25
(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'
tmarrinan's avatar
tmarrinan committed
26

tmarrinan's avatar
tmarrinan committed
27
##### Run #####
tmarrinan's avatar
tmarrinan committed
28
* Open Terminal / Cmd
29 30
    * `cd <SAGE2_directory>`
    * `node server.js`
31
* Open Google Chrome (to enable screen sharing, go to chrome://flags and enable "Enable screen capture support in getUserMedia()")
32 33 34 35 36
    * Table of Contents: `http://<host>:<index_port>`
    * Display Client: `https://<host>:<port>/?clientID=<ID>`
    * Audio Client: `https://<host>:<port>/audioManager.html`
    * SAGE UI: `https://<host>:<port>/sageUI.html`
    * SAGE Pointer: `https://<host>:<port>/sagePointer.html` (Allow pop-ups)
Thomas Marrinan's avatar
Thomas Marrinan committed
37 38 39 40 41 42 43 44 45 46 47

##### Supported File Types #####
* Images
    * JPEG
    * PNG
    * TIFF
    * BMP
    * PSD
* Videos
    * MP4
* PDFs
tmarrinan's avatar
tmarrinan committed
48 49

##### Notice #####
Luc Renambot's avatar
Luc Renambot committed
50
SAGE and SAGE2 are trademarks of the University of Illinois Board of Trustees (SAGE™ and SAGE2™).