forked from GNUsocial/gnu-social
Added README
This commit is contained in:
parent
0ef7c5559f
commit
3dce582182
35
plugins/Irc/README
Normal file
35
plugins/Irc/README
Normal 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' => '...'
|
||||
));
|
||||
|
Loading…
Reference in New Issue
Block a user