Skip to content

Commit

Permalink
Add license and update read me
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrocarrico committed Aug 20, 2012
1 parent 715f5b0 commit 78009a0
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
@@ -1,3 +1,29 @@
# Pimon

A simple server stats monitor designed for the raspberry pi.
![Pimon](http://pedrocarrico.net/pimon.jpg "Pimon")

## Description
Pimon is a simple server stats monitor designed for the raspberry pi.
It uses redis lists to show the latest 6 observed statistics and also uses
highcharts to display some nice graphs on your web browser.

## What do I need to get it to work?
1. Install redis
2. Copy the supplied config.yml.sample to config.yml
3. bundle
4. ruby pimon.rb # run the sinatra app
5. ruby stats_checker.rb # collect some stats
6. go to http://localhost:4567 and PROFIT!
7. You may want to put "ruby stats_checker.rb" in your crontab to collect some stats over time

## Configuration (config.yml)
1. basic_auth - enable or disable, configure username and password
2. redis - configure the location of the redis socket

## TODO
1. More configuration options
2. Have a If-Modified-Since/Last-Modified request/response HTTP header
3. More control over the time slices

## Copyright
Licensed under the [WTFPL](http://en.wikipedia.org/wiki/WTFPL "Do What The Fuck You Want To Public License") license.
13 changes: 13 additions & 0 deletions WTFPL-LICENSE
@@ -0,0 +1,13 @@
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. You just DO WHAT THE FUCK YOU WANT TO.

0 comments on commit 78009a0

Please sign in to comment.