README.md 3.38 KB
Newer Older
dan's avatar
dan committed
1
# Situation Room
Julien Duponchelle's avatar
Readme  
Julien Duponchelle committed
2

dan's avatar
dan committed
3 4 5 6 7 8 9 10
Situation Room allows you to display multiple web resources on a single monitor.

Possible use cases:

* Create ersatz tactical overviews for display; for example, a combination of [Graphite](http://graphite.wikidot.com/) and [Nagios](http://www.nagios.org/) views that can provide a rapid, real-time overview of your ecosystem.
* Display advertisements or other information across multiple monitors in a retail setting.

## Screenshots
Julien Duponchelle's avatar
Readme  
Julien Duponchelle committed
11

12
Console view:
Julien Duponchelle's avatar
BR  
Julien Duponchelle committed
13

14 15
<img src="http://github.com/noplay/situation-room/blob/master/images/console.png?raw=true"/>

dan's avatar
dan committed
16
Sample monitor view with a video at top left, two graph images, and a webpage:
Julien Duponchelle's avatar
BR  
Julien Duponchelle committed
17

18
<img src="http://github.com/noplay/situation-room/blob/master/images/monitor.png?raw=true"/>
Julien Duponchelle's avatar
Logo  
Julien Duponchelle committed
19

dan's avatar
dan committed
20
## Features
21

dan's avatar
dan committed
22 23
* Simple web interface to control which resources are being displayed.
* Support for web pages, individual images, and videos.
dan's avatar
dan committed
24
* Multiple monitor support (mirroring _or_ individual displays).
dan's avatar
dan committed
25
* Auto-refresh feature, configurable per resource.
26

dan's avatar
dan committed
27
## Pre-requisites
28

dan's avatar
dan committed
29 30 31
* [Node.js](http://nodejs.org/)
* [NPM](http://npmjs.org/)
* [Socket.io](http://socket.io/)
dan's avatar
dan committed
32
* A modern browser such as [Chrome](http://www.google.com/chrome)
Julien Duponchelle's avatar
Readme  
Julien Duponchelle committed
33

Julien Duponchelle's avatar
Julien Duponchelle committed
34 35
## Download

Julien Duponchelle's avatar
Julien Duponchelle committed
36
* 0.3.2: http://github.com/noplay/situation-room/zipball/0.3.2
Julien Duponchelle's avatar
Julien Duponchelle committed
37

dan's avatar
dan committed
38
## Configure
Julien Duponchelle's avatar
Readme  
Julien Duponchelle committed
39

dan's avatar
dan committed
40
* Play with `config.js` as necessary.
Julien Duponchelle's avatar
Readme  
Julien Duponchelle committed
41

dan's avatar
dan committed
42
## Usage
Julien Duponchelle's avatar
Licence  
Julien Duponchelle committed
43

dan's avatar
dan committed
44 45
* `node server.js`
* By default, the tactical view will be available at `http://127.0.0.1:4001`
Julien Duponchelle's avatar
Julien Duponchelle committed
46
* By default, the second tactical view will be available at `http://127.0.0.1:4001#1`
dan's avatar
dan committed
47
* By default, the control console will be available at `http://127.0.0.1:4000`
Julien Duponchelle's avatar
Readme  
Julien Duponchelle committed
48

Julien Duponchelle's avatar
Julien Duponchelle committed
49 50
## Changelog

Julien Duponchelle's avatar
Julien Duponchelle committed
51
0.3.2:
Julien Duponchelle's avatar
Julien Duponchelle committed
52

Julien Duponchelle's avatar
Julien Duponchelle committed
53 54 55 56 57
* Fix quote issues
* Background images
* Cosmetic improvements


Julien Duponchelle's avatar
Julien Duponchelle committed
58
0.3.1:
dan's avatar
dan committed
59 60

* Fix a little parse error thanks to Nico.
Julien Duponchelle's avatar
Julien Duponchelle committed
61

Julien Duponchelle's avatar
Julien Duponchelle committed
62
0.3:
Julien Duponchelle's avatar
Julien Duponchelle committed
63

dan's avatar
dan committed
64
* Support videos.
Julien Duponchelle's avatar
Julien Duponchelle committed
65 66

0.2:
dan's avatar
dan committed
67 68

* Support multiple display.
Julien Duponchelle's avatar
Julien Duponchelle committed
69 70

0.1:
dan's avatar
dan committed
71 72

* Initial version.
Julien Duponchelle's avatar
Julien Duponchelle committed
73

dan's avatar
dan committed
74
## Thanks
Julien Duponchelle's avatar
Readme  
Julien Duponchelle committed
75

dan's avatar
dan committed
76
The following projects :
dan's avatar
dan committed
77

Julien Duponchelle's avatar
Julien Duponchelle committed
78 79
* [node.js](http://nodejs.org)
* [socket.io](http://socket.io)
dan's avatar
dan committed
80 81
* [jQuery](http://www.jquery.org)
* [jLayout](http://www.bramstein.com/projects/jlayout/)
82
* [fullScreenBG](http://github.com/conzett/jquery.fullScreenBG)
Julien Duponchelle's avatar
Readme  
Julien Duponchelle committed
83

Julien Duponchelle's avatar
Julien Duponchelle committed
84 85
Background image Vincent Klaiber (Attribution 3.0 Unported (CC BY 3.0)) (http://subtlepatterns.com/?p=852)

dan's avatar
dan committed
86
The following people :
dan's avatar
dan committed
87

dan's avatar
dan committed
88 89 90
* [pyr](http://github.com/pyr/)
* [Daniel](http://github.com/phrawzty/)
* Sclo
dan's avatar
dan committed
91
* [Nico](https://twitter.com/#!/warpdesign_)
Julien Duponchelle's avatar
Thanks  
Julien Duponchelle committed
92

dan's avatar
dan committed
93
## Licence
Julien Duponchelle's avatar
Thanks  
Julien Duponchelle committed
94

dan's avatar
dan committed
95
This software is distributed under an MIT licence.
Julien Duponchelle's avatar
Thanks  
Julien Duponchelle committed
96

dan's avatar
dan committed
97
Copyright 2011 © Julien Duponchelle
Julien Duponchelle's avatar
Licence  
Julien Duponchelle committed
98

dan's avatar
dan committed
99 100 101 102 103 104 105 106 107 108 109
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software
> and associated documentation files (the "Software"), to deal in the Software without
> restriction, including without limitation the rights to use, copy, modify, merge, publish,
> distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
> Software is furnished to do so, subject to the following conditions:
> The above copyright notice and this permission notice shall be included in all copies or
> substantial portions of the Software.
> The Software is provided "as is", without warranty of any kind, express or implied, including
> but not limited to the warranties of merchantability, fitness for a particular purpose and
> noninfringement. In no event shall the authors or copyright holders be liable for any claim,
> damages or other liability, whether in an action of contract, tort or otherwise, arising from,
Julien Duponchelle's avatar
Julien Duponchelle committed
110
> out of or in connection with the software or the use or other dealings in the Software.