Apirc v1.1 - Java (c) IRC applet

--------------------------------



Apirc is a Java (c) IRC multi-threaded applet with private msg,

channel, nickname control, channel list, ban windows, that allow

people visiting a web site to connect to irc servers. Aprelay is

an IRC relay only necessary if you want to allow people to connect

to outside irc servers, because of the Java network security.



- Up to 128 simultaneous connections on the relay (P133 40Mo)

- Default parameters can easily be set in the html page (servers,

  channels, ..)

- Advantages of the multi OS compatibility of the applet (Macintosh,

  Windows, Unix)

- The relay (not required to connect to your own irc server) works

  on Linux, Win NT4, Win 95

- Up to 5 simultaneous server connections and 10 open channels on

  the user side



You must have the original compressed file :

 apirc-1.1.exe     for Windows NT-95

 apirc-1.1.tar.gz  for Unix/Linux



If you want to run your own irc server, this server and the http

web server must reside on the same machine to avoid the Aprelay

installation.



Some irc servers for Windows NT, Windows95, and Unix/Linux :

 W95+NT: http://www.storer.net/ircd.html

 UNIXes: ftp://ftp.funet.fi/pub/unix/irc/server/irc2.x.x.tgz



If you need to use the relay, it must be runned on the machine that

houses the http server, that means you must have system access on

the computer, or tell your ISP/administrator to install and run it.



If you can't do that, you may copy the html code (applet part)

from http://www.id-net.fr/prgs and modify codebase as follows :

codebase="http://www.id-net.fr/prgs/apirc", but you will only be

able to connect on irc.id-net.fr from your homepage.



This applet was successfully tested on Netscape Windows95 3.01

 & 4.03 and on IE Windows95 3.01 & 4.01.

It works correctly on MSIE Macintosh 3.01 beta but some menus are

 curiously disabled.

It works well on Netscape Macintosh 3.01, but with a slow Java 

It works well on Netscape Linux 4.04.





Installation without Aprelay (you must have your own IRC server)

----------------------------------------------------------------

This IRC server and the http web server must reside on the same

machine. In your web root directory, create a subdirectory called

'apirc' and install all the Java classes (*.class) in it.



The html file should be :



<applet codebase="apirc" code=apirc.class width=240

 height=150 align=center>

<param name=defaultnickname value="ApircUser">

<param name=server1 value="irc.yourserver.com">

<param name=defaultserver value="irc.yourserver.com">

<param name=port1 value="6666">

<param name=port2 value="6667">

<param name=port3 value="6668">

<param name=port4 value="6669">

<param name=port5 value="6670">

<param name=defaultport value="6667">

<param name=channel1 value="#Geneva">

<param name=channel2 value="#France">

<param name=channel3 value="#Quebec">

<param name=defaultchannel value="#Geneva">

</applet>



You must change some values according to your own irc server, and

channel+port configuration.





Installation with Aprelay

-------------------------

This allow people to connect to all IRC servers.

E.g. Efnet, Undernet, Ircnet, ... IRC networks without limitations.

The relay has been tested on Windows NT, Windows 95, Linux 2.0.x,

and can be easily compiled on other platforms.





If you downloaded 'apirc-1.1.exe', the binary file is available

(Win95/98/NT); As it was compiled with the gcc Cygnus compiler

(http://www.cygnus.com), the file cygwin[.dll] and the binary

aprelay[.exe] must be placed together in the same directory, and

aprelay[.exe] started.



To avoid clones (some IRCs K-line if clones), start also apidentd.

You should add aprelay[.exe] (and apidentd if used) in your Startup

folder to make it restarting after a reboot.





If you downloaded 'apirc-1.1.tar.gz', you must compile it. Before that,

if you do not have root access, you must '#undef CLASSIDENT'. On most

Unix platforms, 'cc -o aprelay aprelay.c' or 'gcc -o aprelay aprelay.c'

will work. On Sparc, try with 'gcc aprelay.c -lsocket -lnsl -lresolv

-o aprelay' (not verified).



This relay is not supported, if you have problems we will try to

help you, but without any garantee.



You can start it directly by typing 'aprelay', but we recommand using

a newly created username to start the process: create a new user in

your /etc/passwd file (not directly on some OSes, see your manuals)

named 'apircuser' for instance. If you have root access, do a 'chmod

u+s aprelay' under root. Then Aprelay will be called this way:

'/bin/su apircuser -c /usr/marc/apirc/aprelay' (paths must be adapted).



In /etc/rc.d/rc.local or equivalent, you should add this line to make

Aprelay restarting after a reboot.





 In your web root directory, create a subdirectory called 'apirc'

and install all the Java classes (*.class) in it.



The html file should be :



<applet codebase="apirc" code=apirc.class width=240

 height=150 align=center>

<param name=defaultnickname value="ApircUser">

<param name=server1 value="irc.franet.org">

<param name=server3 value="irc.efnetserver2.net">

<param name=server5 value="irc.dalnetserver3.com">

<param name=defaultserver value="irc.franet.org">

<param name=port1 value="6666">

<param name=port2 value="6667">

<param name=port3 value="6668">

<param name=port4 value="6669">

<param name=port5 value="6670">

<param name=defaultport value="6667">

<param name=channel1 value="#Geneva">

<param name=channel2 value="#Texas">

<param name=channel3 value="#France">

<param name=channel4 value="#Friendly">

<param name=channel5 value="#Quebec">

<param name=defaultchannel value="#Geneva">

<param name=relay value="webmachine.domain.com">

<param name=relayport value="8888">

</applet>



The 'relay' must be the hostname (not the URL) of the computer that

houses the web server (with your website) and Aprelay. E.g if your

web is 'http://www9.ml.org/chat', value will be "www9.ml.org".



The 'relayport' must be 8888, except if you modify the port number in

the Aprelay source file. The relay value is the exact machine name or

IP number where resides Aprelay.



Downloading & demo :

--------------------

http://www.id-net.fr/prgs



Other demo (in french) :

------------------------

http://www.franet.org



If you are from a country where french is spoken, and want to add freely your

own irc server to the Franet IRC Network, please visit http://www.franet.org



Copyrights :

------------

- Apirc is copyrighted P.Toilon IdNet (http://www.id-net.fr)

- Java is a trademark of Sun Microsystems, Inc. (http://www.sun.com)

- Windows and Microsoft Internet Explorer (MSIE) are copyrighted

  Microsoft Corporation (http://www.microsoft.com)

- Cygnus gcc compiler is copyrighted by Cygnus Solutions (http://www.cygnus.com)

- Netscape is copyrighted by Netscape Communications Corporation

  (http://www.netscape.com)