Mercurial > prosody-wiki

annotate mod_ircd.wiki @ 233:4824ae8b1f1a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_ircd wiki: updated to reflect changes.
author Marco Cirillo <maranda@lightwitch.org>
date Mon, 28 Nov 2011 15:34:02 +0000
parents b5e2876a6320
children b5e76dc1ac2f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
1 #summary IRC to XMPP interface to allow IRC clients to connect to chatrooms
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
2 #labels Stage-Alpha
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
3
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
4 = Introduction =
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
5
103
1100de0e9a4b Edited wiki page through web user interface.
MWild1
parents: 102
diff changeset
6 Whether you like it or not, XMPP is the future, but that pesky IRC just won't go away :)
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
7
103
1100de0e9a4b Edited wiki page through web user interface.
MWild1
parents: 102
diff changeset
8 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
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
9
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
10 = Usage =
103
1100de0e9a4b Edited wiki page through web user interface.
MWild1
parents: 102
diff changeset
11 In your config file put something similar to the following:
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
12
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
13 {{{
233
4824ae8b1f1a mod_ircd wiki: updated to reflect changes.
Marco Cirillo <maranda@lightwitch.org>
parents: 226
diff changeset
14 Component "irc2muc.example.com" "ircd"
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
15 conference_server = "conference.example.com"
233
4824ae8b1f1a mod_ircd wiki: updated to reflect changes.
Marco Cirillo <maranda@lightwitch.org>
parents: 226
diff changeset
16 listener_port = 7000
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
17 }}}
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
18
103
1100de0e9a4b Edited wiki page through web user interface.
MWild1
parents: 102
diff changeset
19 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.
1100de0e9a4b Edited wiki page through web user interface.
MWild1
parents: 102
diff changeset
20
223
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
21 = Warning =
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
22
233
4824ae8b1f1a mod_ircd wiki: updated to reflect changes.
Marco Cirillo <maranda@lightwitch.org>
parents: 226
diff changeset
23 The plugin stability, and/or serving compatibility with most of the IRC clients is yet to be determined.
223
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
24
224
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
25 = Install =
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
26
226
b5e2876a6320 fixed links format
maranda3985@gmail.com
parents: 225
diff changeset
27 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
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
28
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
29 Instructions:
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
30 * Clone both the Verse/Squish repo and/or download the latest tips from 'em (in that case you'll have to decompress the tip zips/tarballs)
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
31 * Edit Verse's squish file so that all plugins cept the presence and groupchat ones will be commented
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
32 * In your Squish directory type make install
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
33 * Run squish.lua --use-http into your Verse's directory, and move verse.lua into where mod_ircd files from google code's HG are stored
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
34 * Run squish.lua again
225
cef6ddd139aa dusted bad character code.
Marco Cirillo <maranda@lightwitch.org>
parents: 224
diff changeset
35 * Move the mod_ircd.out.lua to your prosody's plugin directory renaming it back to mod_ircd.lua
224
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
36
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
37 = Compatibility =
223
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
38 ||0.8||Works||
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
39 ||0.7||Uncertain||
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
40 ||0.6||Uncertain||
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
41
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
42 = Todo =
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
43 * Authentication
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
44 * SSL
233
4824ae8b1f1a mod_ircd wiki: updated to reflect changes.
Marco Cirillo <maranda@lightwitch.org>
parents: 226
diff changeset
45 * Many improvements to handling of IRC and XMPP