eliseuamaro/gnu-social
1
0
Fork 0
forked from GNUsocial/gnu-social
Code Issues Pull Requests Releases Wiki Activity

Added README

Browse Source
This commit is contained in:
Luke Fitzgerald 2010-07-04 10:24:22 -07:00
parent 0ef7c5559f
commit 3dce582182
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
plugins/Irc/README Normal file
View File

@ -0,0 +1,35 @@
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
========
host*: => Hostname of IRC server
port*: => Port of IRC server
username*: => Username of bot
realname*: => Real name of bot
nick*: => Nickname of bot
password: Password
transport: Set to 'ssl' to enable SSL
encoding: Set to UTF8 to enable UTF8 encoding
* required
Example
=======
addPlugin('irc', array(
'host' => '...',
'port' => '...',
'username' => '...',
'realname' => '...',
'nick' => '...'
));