2012-02-24 07:53:45 +00:00
Riemann-Dash
2012-02-18 23:40:30 +00:00
============
2012-02-18 23:22:24 +00:00
2013-01-16 09:32:51 +00:00
A javascript, websockets-powered dashboard for Riemann.
2012-02-18 23:22:24 +00:00
2012-02-18 23:40:30 +00:00
Get started
==========
2012-02-18 23:22:24 +00:00
2012-02-18 23:40:30 +00:00
``` bash
2012-02-24 07:53:45 +00:00
gem install riemann-dash
riemann-dash
2012-02-18 23:40:30 +00:00
```
2012-02-18 23:22:24 +00:00
2013-01-16 09:32:51 +00:00
Then open http://localhost:4567 in a browser. Riemann-dash will connect to the local host (relative to your browser) by default, and show you a small manual.
2012-02-18 23:22:24 +00:00
2012-02-18 23:40:30 +00:00
Configuring
===========
2012-02-18 23:22:24 +00:00
2012-02-24 07:53:45 +00:00
Riemann-dash takes an optional config file, which you can specify as the first
2012-02-18 23:40:30 +00:00
command-line argument. If none is given, it looks for a file in the local
directory: config.rb. That file can override any configuration options on the
2013-03-03 06:48:09 +00:00
Dash class, and hence, all Sinatra configuration.
2012-02-18 23:22:24 +00:00
2012-02-18 23:40:30 +00:00
``` ruby
set :port, 6000 # HTTP server on port 6000
2013-03-08 03:11:06 +00:00
config[:ws_config] = 'custom/config.json' # Specify custom workspace config
2012-02-18 23:40:30 +00:00
```
2013-03-11 10:26:30 +00:00
Development
===========
$ git clone git://github.com/mindreframer/riemann-dash.git
$ cd riemann-dash
$ bundle
2013-03-11 10:30:16 +00:00
Releasing
==========
$ rake build
2013-03-11 11:10:34 +00:00
$ rake release
REPL
====
$ sh/c
> irb :001 > Riemann::Dash::VERSION
> => "0.2.2"
