gnu-social/plugins/Irc/README

46 lines
1.6 KiB
Plaintext
Raw Normal View History

2010-07-05 02:24:22 +09:00
The IRC plugin allows users to send and receive notices over an IRC network.
Installation
============
add "addPlugin('irc',
array('setting'=>'value', 'setting2'=>'value2', ...);"
to the bottom of your config.php
scripts/imdaemon.php included with StatusNet must be running. It will be started by
the plugin along with their other daemons when you run scripts/startdaemons.sh.
See the StatusNet README for more about queuing and daemons.
Settings
========
2010-07-09 18:02:50 +09:00
host*: Hostname of IRC server
port: Port of IRC server (defaults to 6667)
2010-07-09 18:02:50 +09:00
username*: Username of bot
realname*: Real name of bot
nick*: Nickname of bot
2010-07-05 02:24:22 +09:00
password: Password
2010-07-09 18:02:50 +09:00
nickservpassword: NickServ password for identification
2010-07-27 03:13:00 +09:00
nickservidentifyregexp: Override existing regexp matching request for identification from NickServ
2010-07-09 18:02:50 +09:00
channels: Channels for bot to idle in
transporttype: Set to 'ssl' to enable SSL
2010-07-21 21:21:37 +09:00
encoding: Set to change encoding
pinginterval: Set to change the number of seconds between pings (helps keep the connection open)
Defaults to 120 seconds
regcheck: Check user's nicknames are registered, enabled by default, set to false to disable
regregexp: Override existing regexp matching response from NickServ if nick checked is registered.
Must contain a capturing group catching the nick
unregregexp: Override existing regexp matching response from NickServ if nick checked is unregistered
Must contain a capturing group catching the nick
2010-07-05 02:24:22 +09:00
* required
Example
=======
addPlugin('irc', array(
'host' => '...',
'username' => '...',
'realname' => '...',
2010-07-09 18:02:50 +09:00
'nick' => '...',
'channels' => array('#channel1', '#channel2')
2010-07-05 02:24:22 +09:00
));