annotate mod_ircd.wiki @ 223:2838422a8bc1

adjusted wiki.
author Marco Cirillo <maranda@lightwitch.org>
date Mon, 26 Sep 2011 01:51:29 +0000
parents 1100de0e9a4b
children f2addd5ab93b
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 {{{
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
14 Component "irc.example.com" "ircd"
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
15 conference_server = "conference.example.com"
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
16 }}}
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
17
103
1100de0e9a4b Edited wiki page through web user interface.
MWild1
parents: 102
diff changeset
18 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
19
223
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
20 = Warning =
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
21
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
22 For now the port number used by the plugin is hardcoded to be 7000, if you want to change it, you'll need to edit the plugin file just search for "7000" in your text editor and replace it with your port of choice.
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
23 Also the plugin stability, and/or serving compatibility with most of the IRC clients is yet to be determined.
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
24
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
25 = Compatibility =
223
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
26 ||0.8||Works||
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
27 ||0.7||Uncertain||
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
28 ||0.6||Uncertain||
102
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
29
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
30 = Todo =
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
31 * Authentication
1defbd44efe9 Created wiki page through web user interface.
MWild1
parents:
diff changeset
32 * SSL
223
2838422a8bc1 adjusted wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 103
diff changeset
33 * Many improvements to handling of IRC and XMPP