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 (defaults to 6667)
  17 username*: Username of bot
  18 realname*: Real name of bot
  19 nick*: Nickname of bot
  20 password: Password
  21 nickservpassword: NickServ password for identification
  22 nickservidentifyregexp: Override existing regexp matching request for identification from NickServ
  23 channels: Channels for bot to idle in
  24 transporttype: Set to 'ssl' to enable SSL
  25 encoding: Set to change encoding
  26 pinginterval: Set to change the number of seconds between pings (helps keep the connection open)
  27               Defaults to 120 seconds
  28 regcheck: Check user's nicknames are registered, enabled by default, set to false to disable
  29 regregexp: Override existing regexp matching response from NickServ if nick checked is registered.
  30            Must contain a capturing group catching the nick
  31 unregregexp: Override existing regexp matching response from NickServ if nick checked is unregistered
  32              Must contain a capturing group catching the nick
  33
  34 * required
  35
  36 Example
  37 =======
  38 addPlugin('irc', array(
  39     'host' => '...',
  40     'username' => '...',
  41     'realname' => '...',
  42     'nick' => '...',
  43     'channels' => array('#channel1', '#channel2')
  44 ));
  45