Add documentation -- ASR

README.md

@@ -1,4 +1,17 @@
-nagios-fifo.pl
-==============
+nagios-fifo
+===========
+
+IRSSI BOT to handle nagios/irssi communication.
+
+To ease the use of the bot configuration, I use to link different
+files from the BOT configuration director etc/ bin/ var/ up to
+respective irssi directories :
+
+1/ setup an irssi client, inside a screen.
+2/ symlink ~/.irssi/ as etc/config.directory
+3/ symlink the scripts you want to load to as ~/.irssi/scripts/autorun
+4/ edit the ~/.irssi/config to join the communication channel
+5/ symlink it to etc/config.local
+6/ start "screen irssi"
+
 
-BOT IRSSI de management de Nagios, via IRSSI.

etc/config.template

@@ -1,3 +1,8 @@
+# Edit :
+# password/nick
+# autojoin
+# Immortal window (bottom of the configuration file)
+
 servers = (
   { address = "irc.stealth.net"; chatnet = "IRCnet"; port = "6668"; },
   { address = "irc.efnet.net"; chatnet = "EFNet"; port = "6667"; },
@@ -7,15 +12,16 @@ servers = (
     port = "6697";
     use_ssl = "yes";
     ssl_verify = "no";
-    autoconnect = "no";
+    autoconnect = "no"; #######################
+    autosendcmd = "/^msg nickserv IDENTIFY mybotpassword";
   },
   {
     address = "irc.geeknode.net";
     chatnet = "GeekNode";
-    autoconnect = "yes";
+    autoconnect = "yes"; #######################
     port = "6697";
-    use_ssl = "yes";
-    autosendcmd = "/^msg C nick IDENTIFY hallyday";
+    use_ssl = "no";
+    autosendcmd = "/^msg C nick IDENTIFY mybotpassword";
   },
   { 
     address = "irc.undernet.org";
@@ -64,34 +70,23 @@ chatnets = {
     max_whois = "30";
   };
   SILC = { type = "SILC"; };
-  FreeNode = {
-    type = "IRC";
-    autosendcmd = "/^msg NickServ IDENTIFY totoqsd45g;wait 2000";
-  };
-  GeekNode = {
-    type = "IRC";
-    autosendcmd = "/^msg C nick IDENTIFY TC-14;wait 2000";
-  };
 };
 
 channels = (
+###################################
   {
-    name = "#root";
+    name = "#main_channel";
     chatnet = "geeknode";
-    password = "hallyday";
+    password = "command_chan_password";
     autojoin = "Yes";
   },
-  { name = "#root"; chatnet = "geeknode"; autojoin = "Yes"; },
-  { name = "#lautre.net"; chatnet = "freenode"; autojoin = "yes"; },
-  { name = "#test"; chatnet = "geeknode"; autojoin = "yes"; },
-  { name = "#inter"; chatnet = "geeknode"; autojoin = "yes"; },
   {
-    name = "#naglautre";
+    name = "#test";
     chatnet = "geeknode";
     autojoin = "yes";
-    password = "hallyday";
   }
 );
+###################################
 
 aliases = {
   J = "join";
@@ -142,6 +137,11 @@ aliases = {
   ATAG = "WINDOW SERVER";
 };
 
+
+#######################
+# Cosmetic parameters #
+#######################
+
 statusbar = {
   # formats:
   # when using {templates}, the template is shown only if it's argument isn't
@@ -264,7 +264,7 @@ statusbar = {
 settings = {
   "irc/core" = {
     join_auto_chans_on_invite = "yes";
-    ctcp_version_reply = "TC-14 protocol bot 1.0.1";
+    ctcp_version_reply = "TC-14 protocol bot 1.3.1";
   };
   core = {
     real_name = "Protocol Droid TC-14, at your service.";
@@ -289,10 +289,11 @@ settings = {
   "fe-text" = { actlist_sort = "refnum"; };
 };
 conversions = {
-  "#epplug" = "iso8859-1";
+  "#clx" = "iso8859-1";
   "#lautre.net" = "iso-8859-1";
-  "#toto" = "utf8";
+  "#gitoyen" = "iso-8859-1";
   "#bepo" = "utf8";
+  "#spip" = "utf8";
 };
 hilights = ( { text = "asr"; nick = "yes"; word = "yes"; } );
 windows = {
@@ -304,15 +305,17 @@ windows = {
   };
   2 = { immortal = "yes"; name = "hilight"; sticky = "yes"; };
   3 = {
+###################################
     items = (
       {
         type = "CHANNEL";
         chat_type = "IRC";
-        name = "#root";
+        name = "#main_channel";
         tag = "GeekNode";
       }
     );
     sticky = "yes";
+###################################
   };
 };
 mainwindows = {