Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
zifnab06 committed Jan 3, 2012
1 parent e9d6c55 commit 371075d
Showing 1 changed file with 15 additions and 24 deletions.
39 changes: 15 additions & 24 deletions README
@@ -1,4 +1,6 @@
WebChat2.0 (C) Chris Chabot <chabotc@xs4all.nl> 2006-2007
WebChat2.0
Original work by Chris Chabot <chabotc@xs4all.nl> 2006-2007
Rewrite and modifications by Tom Powell (zifnab@zifnab.net) and KyleXY (kyle@ospnet.org) 2011-2012
Released under the GPLv2, See LICENCE for more information.


Expand All @@ -8,32 +10,21 @@ PHP (5.x) backend daemon that connects to a IRC server.

To run this application you need a few things:

1) A IRC server configured to allow many(!) connections from
localhost (or the host where the daemon resides). Normal IRC
servers are configured to allow only upto 3 connections from
the same IP address, so you need to change this to the ammount
of clients you want your webchat able to host (256-1024 is a
reasonable number to start with). Also disable ident checking,
because everything will be comming from localhost, this is
pointless to do and only makes the process of connecting slower.
During development i've used hybrid-ircd so if you run into
trouble, try using that ircd :-)
1) An IRC server that is configured to use WEBIRC. This
has been tested on charybdis ONLY. Other IRCDs might not work.
If you have another IRCD, please fill out an issue on our git
page (http://github.com/zifnab06/webchat/issues), and we'l try
to add support for your IRCD.

2) Run the PHP chat daemon, it functions as the gateway between
the browser based javascript frontend, and the irc backend, for
extra paranoia protection, you could run the chat daemon in a
chroot envirioment, read one of the many FAQ's available on this
topic (it involves making a directory structure, using ldd to see
what libs your php executable needs, copying those over, plus your
php cli binary) and then running something like:
the browser based javascript frontend, and the irc backend.

# exec /usr/sbin/chroot /var/lib/php-chroot /usr/bin/php -Cq /chat/chat.php
3) A modern browser! The chat application should work with IE7+
firefox, and chrome. It does not work correctly in IE6 (your browser
is over 10 years old, please update it!)

3) A modern browser! The chat application should work with IE6, IE7
and firefox.

4) A willingness to accept that this software isn't finished yet :-)
Feel free to mail sugestions, file bugs, write wiki pages, and send
patches!
4) Realize we aren't finished yet. Feel free to participate in our
developement! Everything is located on our github,
http://github.com/zifnab06/webchat. Feel free to contribute!


0 comments on commit 371075d

Please sign in to comment.