Mercurial > prosody-modules
comparison mod_ircd/README.wiki @ 1782:29f3d6b7ad16
Import wiki pages
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Mon, 24 Aug 2015 16:43:56 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 1781:12ac88940fe3 | 1782:29f3d6b7ad16 |
|---|---|
| 1 #summary IRC to XMPP interface to allow IRC clients to connect to chatrooms | |
| 2 #labels Stage-Alpha, Deprecated | |
| 3 | |
| 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!* | |
| 5 | |
| 6 = Introduction = | |
| 7 | |
| 8 Whether you like it or not, XMPP is the future, but that pesky IRC just won't go away :) | |
| 9 | |
| 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. | |
| 11 | |
| 12 = Usage = | |
| 13 In your config file put something similar to the following: | |
| 14 | |
| 15 {{{ | |
| 16 Component "irc2muc.example.com" "ircd" | |
| 17 conference_server = "conference.example.com" -- required | |
| 18 listener_port = 7000 | |
| 19 }}} | |
| 20 | |
| 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 | |
| 23 = Warning = | |
| 24 | |
| 25 The plugin stability, and/or serving compatibility with most of the IRC clients is yet to be determined. | |
| 26 | |
| 27 = Install = | |
| 28 | |
| 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. | |
| 30 | |
| 31 Instructions (temporarily changed): | |
| 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) | |
| 33 * In your Squish directory type make install | |
| 34 * Back into your mod_ircd directory call squish with --verse=./verse/verse.lua | |
| 35 * Move the mod_ircd.lua file to your prosody's plugins directory | |
| 36 | |
| 37 = Compatibility = | |
| 38 ||0.8||Works|| | |
| 39 ||0.7||Uncertain|| | |
| 40 ||0.6||Doesn't work|| | |
| 41 | |
| 42 = Todo = | |
| 43 * Authentication | |
| 44 * SSL | |
| 45 * Many improvements to handling of IRC and XMPP |