README in bloopletech-webstats-0.3.0 vs README in bloopletech-webstats-0.5.0

- old
+ new

@@ -35,28 +35,30 @@ ------- If all you want to do is be able to view the performance statistics for your server in a web browser, then you don't need to use any of these clients; going to http://<server's hostname>:9970/ will do just fine. But if you want to have Growl or email notification when something goes wrong, without having to look at a web page all the time, then you'll want one of the client applications that come with Webstats. Right now there's only one client application available, which is a Growl notifier. The Growl notifier only works on OS X, with RubyCocoa installed. This application runs in the background and monitors the server; if the server goes under high CPU load for more than a few seconds, or if the server is nearly out of memory, you'll get a Growl notification saying what the problem is. This way, you can just set and forget, knowing that Webstats will report any problems. -To run the Growl notifier, open a terminal on your computer, then run (the first line is only needed the first time you run the notifier): -~$ git clone git://github.com/bloopletech/webstats.git +To run the Growl notifier, first install Webstats on your local machine, using the installation instructions below (Skip the step that starts the server application). Then, if you installed webstats locally via rubygems, run: +~$ webstats_growl_notifier + +Otherwise, if you installed webstats manually, run: ~$ cd webstats/clients/growl_notifier -~/webstats/clients/growl_notifier$ ruby growl_notifier.rb http://<server's hostname>:9970/ +~/webstats/clients/growl_notifier$ ruby growl_notifier.rb -Where server's hostname is the host name of the server you want to monitor (e.g. bloople.net). The Growl notifier will then run in the background. +The first time you run the growl notifier, it will create a configuration file at ~/.webstats_clients; you must edit this file to set the URL's for the growl notifier to monitor. The URL's should the the hostnames of the servers you want to monitor, along with the correct port number (e.g. http://bloople.net:9970/). +Once you've edited the configuration file to add your URL's, run the notifier again; the Growl notifier will then run in the background and notify you od any warnings or danger situations on the server. + Installation ------------ You can now install webstats using rubygems; this saves you a bit of hassle. To install webstats on the server via rubygems, ensure github gems are in your gems sources; then run: ~$ sudo gem install bloopletech-webstats To run the server application, run: ~$ webstats The server application will start in the background. - -Coming soon: growl notifier client via rubygems. If you don't want to use rubygems, then follow the below instructions: To install the server app, ssh into the computer you want to monitor. then run: ~$ git clone git://github.com/bloopletech/webstats.git ~$ cd webstats \ No newline at end of file