Add nagios IRC bot

Koumbit is using an IRC bot that Micah provided. It is a pair of perl
scripts that send Nagios notifications as messages in an IRC channel.

Add a class to make installing this IRC bot easy. It also defines
commands 'notify-by-irc' and 'host-notify-by-irc' that can be used with
checks to send notifications via the bot.

Signed-off-by: Gabriel Filion <lelutin@gmail.com>

1 files changed, 34 insertions, 0 deletions

diff --git a/README b/README
index cdcb5d3..aa33592 100644
--- a/README
+++ b/README
@@ -60,6 +60,17 @@ Obviously, the check command must either be defined using nagios_command objects
 files directly.
 
 
+IRC bot
+-------
+
+Notifications can easily be sent to an IRC channel by using a bot. To do so,
+simply include 'nagios::irc_bot' on the nagios server and define the right
+$nagios_nsa_* variables (see the 'Variables' section below).
+
+You can then use the notification commands 'notify-by-irc' and
+'host-notify-by-irc' with service and host definitions to make them report
+state changes over IRC.
+
 Caveats
 =======
 
@@ -102,6 +113,29 @@ Options to change the behavior of the nagios module:
                              may also need to flip "check_external_commands" in
                              "nagios.cfg" to enable this functionality.
 
+- nagios_nsa_socket: This optional variable can be used to specify the path to
+                     the socket file that the IRC daemon should use.
+
+- nagios_nsa_server: When using the IRC bot, this defines the server address of
+                     the IRC network on which the bot will connect.
+
+- nagios_nsa_port: Defines the port number on the IRC server on which the bot
+                   should connect. When this variable is not set, the port used
+                   by default is 6667.
+
+- nagios_nsa_nickname: This is the nickname that the IRC bot will take.
+
+- nagios_nsa_password: Some networks require a password to connect to them.
+                       This defines such a password.
+
+- nagios_nsa_channel: The name of the channel that the IRC bot will join and
+                      will post notifications to.
+
+- nagios_nsa_pidfile: This optional variable can be used to define the path to
+                      the file that will contain the process ID of the IRC bot
+                      daemon.
+- nagios_nsa_realname: The IRC bot user's real name that will be displayed. By
+                       default, the real name is 'Nagios'.
 
 Examples
 ========