plugins/Irc/README

   1 The IRC plugin allows users to send and receive notices over an IRC network.
   2
   3 Installation
   4 ============
   5 add "addPlugin('irc',
   6     array('setting'=>'value', 'setting2'=>'value2', ...);"
   7 to the bottom of your config.php
   8
   9 scripts/imdaemon.php included with StatusNet must be running. It will be started by
  10 the plugin along with their other daemons when you run scripts/startdaemons.sh.
  11 See the StatusNet README for more about queuing and daemons.
  12
  13 Settings
  14 ========
  15 host*: => Hostname of IRC server
  16 port*: => Port of IRC server
  17 username*: => Username of bot
  18 realname*: => Real name of bot
  19 nick*: => Nickname of bot
  20 password: Password
  21 transport: Set to 'ssl' to enable SSL
  22 encoding: Set to UTF8 to enable UTF8 encoding
  23
  24 * required
  25
  26 Example
  27 =======
  28 addPlugin('irc', array(
  29     'host' => '...',
  30     'port' => '...',
  31     'username' => '...',
  32     'realname' => '...',
  33     'nick' => '...'
  34 ));
  35