README for UptimeNotifier Clients

This README should give you the basic information to get started.
For complete, up to date documentation visit
http://www.uptimenotifier.com/documen.jsp.

What is UptimeNotifier?
-----------------------
UptimeNotifier is an Event Notification service.  Use it to send
event notifications to a cell phone, pager, or email.  An event
can be defined as a change in value or state of some property.
For example:
  -  you have unfilled orders that need attantion on your web site
  -  a file or email has arrived and you need to be notified
  -  your web server is running slowly or is not responding
  -  a process has failed
  -  a process has succeeded
  -  a login/logout has occurred
  -  inventory is getting low, its time to reorder stock
  -  your computer is running on its UPS

Events can be positive or negative. The uses for UptimeNotifier are
numerous and varied.

The clients are not interactive.  Once invoked they will perform the
task of sending an event notification to the Notification Server.
Their use is easily automated.  See the UptimeNotifier web
documentation for examples.

Requirements
------------
Perl 5.6 if you are using the Perl Client.

Java VM 1.2 or later should work just fine.

For the shellscript clients you must have either 'wget' or 'lynx'
installed

Installation
------------
The clients should be extracted from their archive and placed anywhere
on your system that is convenient for you.  Remember that you may have
to place executables in your search path and the Java JAR file, if
used, may have to be in your CLASSPATH.

Getting Help
------------
The clients will provide usage instructions if asked:

  java -jar -Dhelp UptimeNotifier-1_2.jar
  java -cp UptimeNotifier-1_2.jar -Dhelp \
                com.uptimenotifier.client.UptimeNotifierClient
  perl UptimeNotifierClient -h
  ./UptimeNotifierClient.sh -h


notifier.properties
-------------------
The notifier.properties file contains all properties that can be used
by the UptimeNotifier clients.  The clients will attempt to process
this file first and then process command-line properties.  A property
in both the properties file and on the command line will be
overridden by the command-line. The supplied properties file is well
documented and can be used as is or renamed.


Examples
--------
Shown here are a few examples of using the UptimeNotifier clients.
For more examples see http://www.uptimenotifier.com/documen.jsp.

  Generic event notification
  --------------------------

  java -jar -Drequest=G -DaccountID=myAccount -Dpassword=myPassword \
      -DuserID=recipientID -Dmessage="A Generic message" \
      UptimeNotifier-1_2.jar

  perl UptimeNotifierClient -rG -a myAccount -pmyPassword -u userID \
      -m "This is a generic message"

  Predefined event notification
  --------------------------

  java -jar -Drequest=P -DaccountID=myAccount -Dpassword=myPassword \
      -DeventID=myEvent UptimeNotifier-1_2.jar

  ./UptimeNotifierClient.sh -rP -a myAccount -pmyPassword -t myEventID


Tips For Using UptimeNotifier
-----------------------------

* If your event notification fails, try again with the verbose option
  on.  This will show more detail about the message being sent.
* Automation is possible using your system's 'cron' or 'at' facility.
* The notifier.properties file keeps certain sensitive information,
  including passwords, in clear text.  Please safeguard your
  passwords by protecting the properties file or by not putting
  passwords in this file.


Questions, comments, and suggestions are welcome at
  mailto:support@uptimenotifier.com.
