annotate mod_ircd.wiki @ 402:421d0865f89d

Update library state
author florob@babelmonkeys.de
date Thu, 12 Sep 2013 17:44:25 +0000
parents f7f2befb0f3e
children
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
374
f7f2befb0f3e Labels are apparently comma-separated
Kim Alvefur <zash@zash.se>
parents: 373
diff changeset
2 #labels Stage-Alpha, Deprecated
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
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
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
6 = Introduction =
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 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
9
103
1100de0e9a4b Edited wiki page through web user interface.
MWild1
parents: 102
diff changeset
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
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
11
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
12 = Usage =
103
1100de0e9a4b Edited wiki page through web user interface.
MWild1
parents: 102
diff changeset
13 In your config file put something similar to the following:
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
14
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
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
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
19 }}}
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
20
103
1100de0e9a4b Edited wiki page through web user interface.
MWild1
parents: 102
diff changeset
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.
1100de0e9a4b Edited wiki page through web user interface.
MWild1
parents: 102
diff changeset
22
223
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
23 = Warning =
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
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
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
26
224
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
27 = Install =
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
28
226
b5e2876a6320 fixed links format
maranda3985@gmail.com
parents: 225
diff changeset
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
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
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
f2addd5ab93b added instructions
Marco Cirillo <maranda@lightwitch.org>
parents: 223
diff changeset
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
8b5492ea07d9 corrected typo.
Marco Cirillo <maranda@lightwitch.org>
parents: 237
diff changeset
35 * Move the mod_ircd.lua file to your prosody's plugins directory
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||
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
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
373
c929df198f10 Mark pages of modules no longer in the repo as Deprecated
Kim Alvefur <zash@zash.se>
parents: 254
diff changeset
45 * Many improvements to handling of IRC and XMPP