Mercurial > prosody-wiki
annotate mod_ircd.wiki @ 300:2dc7d6aab48e
mod_vjud: Add config example of running as a component
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 09 Aug 2012 20:42:22 +0200 |
parents | 83603b9ad5dd |
children | c929df198f10 |
rev | line source |
---|---|
102 | 1 #summary IRC to XMPP interface to allow IRC clients to connect to chatrooms |
2 #labels Stage-Alpha | |
3 | |
235
678b7b96f890
Edited wiki page mod_ircd through web user interface.
MWild1@gmail.com
parents:
234
diff
changeset
|
4 *NOTE: Consider this module currently more of a fun experiment than a serious project for use in production. Note the 'alpha' tag and have fun!* |
234
b5e76dc1ac2f
Edited wiki page mod_ircd through web user interface.
MWild1@gmail.com
parents:
233
diff
changeset
|
5 |
102 | 6 = Introduction = |
7 | |
103 | 8 Whether you like it or not, XMPP is the future, but that pesky IRC just won't go away :) |
102 | 9 |
103 | 10 With this module you can set up a special host on your server to allow connections from IRC clients and bots. They are able to join XMPP chatrooms on a specified conference server. |
102 | 11 |
12 = Usage = | |
103 | 13 In your config file put something similar to the following: |
102 | 14 |
15 {{{ | |
233
4824ae8b1f1a
mod_ircd wiki: updated to reflect changes.
Marco Cirillo <maranda@lightwitch.org>
parents:
226
diff
changeset
|
16 Component "irc2muc.example.com" "ircd" |
254
83603b9ad5dd
little more informative annotation on the configuration.
maranda@lightwitch.org
parents:
239
diff
changeset
|
17 conference_server = "conference.example.com" -- required |
233
4824ae8b1f1a
mod_ircd wiki: updated to reflect changes.
Marco Cirillo <maranda@lightwitch.org>
parents:
226
diff
changeset
|
18 listener_port = 7000 |
102 | 19 }}} |
20 | |
103 | 21 If you don't want your IRC users to have connectivity outside your server then there is no need for the hostnames you specify to be valid DNS entries. |
22 | |
223 | 23 = Warning = |
24 | |
233
4824ae8b1f1a
mod_ircd wiki: updated to reflect changes.
Marco Cirillo <maranda@lightwitch.org>
parents:
226
diff
changeset
|
25 The plugin stability, and/or serving compatibility with most of the IRC clients is yet to be determined. |
223 | 26 |
224 | 27 = Install = |
28 | |
226 | 29 This release requires the [http://code.matthewwild.co.uk/verse/ Verse client library] as dependancy and [http://code.matthewwild.co.uk/squish/ Squish] to meld it with the plugin. |
224 | 30 |
237
6a29d6132f88
updated to reflect changes.
Marco Cirillo <maranda@lightwitch.org>
parents:
236
diff
changeset
|
31 Instructions (temporarily changed): |
6a29d6132f88
updated to reflect changes.
Marco Cirillo <maranda@lightwitch.org>
parents:
236
diff
changeset
|
32 * Clone the Squish repo and/or download the latest tip from it (in that case you'll have to decompress the tip zip/tarball) |
224 | 33 * In your Squish directory type make install |
237
6a29d6132f88
updated to reflect changes.
Marco Cirillo <maranda@lightwitch.org>
parents:
236
diff
changeset
|
34 * Back into your mod_ircd directory call squish with --verse=./verse/verse.lua |
239 | 35 * Move the mod_ircd.lua file to your prosody's plugins directory |
224 | 36 |
102 | 37 = Compatibility = |
223 | 38 ||0.8||Works|| |
39 ||0.7||Uncertain|| | |
236
aa80afcf1282
don't think it's going to work in 0.6 for sure, updating wiki to reflect that.
maranda@lightwitch.org
parents:
235
diff
changeset
|
40 ||0.6||Doesn't work|| |
102 | 41 |
42 = Todo = | |
43 * Authentication | |
44 * SSL | |
254
83603b9ad5dd
little more informative annotation on the configuration.
maranda@lightwitch.org
parents:
239
diff
changeset
|
45 * Many improvements to handling of IRC and XMPP |