Browse Source

Add documentation / readme -- ASR

Gaétan RYCKEBOER 10 years ago
parent
commit
c6c909c732
2 changed files with 28 additions and 7 deletions
  1. 0 0
      INSTALL
  2. 28 7
      README.md

README → INSTALL


+ 28 - 7
README.md

@@ -19,12 +19,33 @@ The bot is made of 3 scripts :
 - tweet.pl made to tweet, take care of a changelog ;
 - tc-14 a simple talkeng droid.
 
-Commands allowed inside a chan are :
-- !nagios list : liste des alertes nagios reçues ici");
-- !nagios help : l'aide");
-- !nagios ack <#ALERTE> <message> : aquitte l'alerte");
-- !nagios check <#ALERTE> : recheck une alerte donnée (service/host)");
-- !nagios refresh [silent] : interroge le nagios pour avoir la liste de toutes les alertes");
+all are designed to work standalone.
 
-The nagios bot is designed to work with nagios notifications 
+Commands allowed by nagios-fifo.pl / Nagios module :
+The nagios bot is designed to work with nagios notifications, via commands.cfg configuration file.
+- !nagios list : list of received alerts
+- !nagios help : l'aide");
+- !nagios ack <#ALERT> <message> 
+               : ACK the alert");
+- !nagios check <#ALERT> 
+               : recheck any alert (service/host)
+- !nagios refresh [silent] 
+               : request nagios livestatus and import all unack alerts
 
+Commands allowed by tc-14.pl / Dumb module :
+- !status      to have a look on inner variables / structures (particularly for the bingo module)
+- !password    to generate a random password
+- !help        totally useless
+- react to some words (essentially in french, feel free to adapt to your needs) :
+  * fortune (displays a fortune cookie sentence) ;
+  * any french/flemish/irish beer ;
+  * any animal name ;
+  * some pedant words, used to check a bingo business card
+  * his own name
+  
+Commands allowed by tweet.pl / admin module :
+- !tweet        : tweet a tweet, on twitter and identi.ca (twitter module broken, to be redisigned)
+- !tweet last   : what was last tweet ?
+- !changelog    : add/list lasts changelogs
+- !lastlog [pattern] 
+                : display last 20 messages [about pattern]