Permalink
Browse files

Beef up readme

  • Loading branch information...
brianjlandau committed Oct 26, 2009
1 parent 3c19ec1 commit 797fe52382828b29b46d2a0c6610881cd8863550
Showing with 28 additions and 1 deletion.
  1. +28 −1 README.md
View
@@ -1,3 +1,30 @@
-Make sure to add this line to your monit control file:
+# Watch-Dog
+
+This is small [Sinatra](http://www.sinatrarb.com/) app for managing a set
+of [monit](http://mmonit.com/) checks on remote web sites.
+
+It allows you specify the URL you want to monitor, text that should be on the page,
+how many failure cycles are required for to report as the site being down, and an email
+address to send the alert to.
+
+There is a very basic web interface that allows to to create and edit which sites you're
+monitoring and reports on the status of the sites you're monitoring.
+
+## Requirements
+
+* Ruby
+* A web server (e.g. apache with [Passenger](http://www.modrails.com/))
+* SQLite3
+* [monit](http://mmonit.com/)
+
+## Setup
+
+1. Copy config/database.example.yml to config/database.yml and fill in the correct settings
+2. Copy config/settings.example.yml to config/settings.yml and fill in the correct settings
+3. Copy config/deploy.example.rb to config/deploy.rb and make the necessary changes
+4. Add this line to your monit control file:
include /path/to/watch-dog/monitrc/**/*.monitrc
+
+
+Copyright (c) 2009 Viget Labs. See LICENSE for details.

0 comments on commit 797fe52

Please sign in to comment.