Documentation
SUPERCHAT:  V4.1


System Requirements

  • Unix, Lynyx or NT operating system
  • Perl 5

Preliminaries

  • Determine the path to PERL 5 on your web server host.  Note that some web hosting companies run both PERL 4 and PERL 5.  Make ABSOLUTELY sure you are not setting this up under PERL 4.  Ask your administrator if you are not sure.
  • Download the tarfile for this program and save it to your desktop.
  • Unpack the tar archive on your desktop using a program that unpacks UNIX TAR ARCHIVES. If you don't have such a program then download WINZIP FREE from SHAREWARE.COM
  • After you have unpacked the TAR archive you will have a collection of folders and files on your desktop.  Now you have to do some basic editing of each of these files (or at least some of them).  Use a text editor such as wordpad, notepad, BBEdit, simpletext, or teachtext to edit the files.  These are NOT WORD PROCESSOR DOCUMENTS they are just simple TEXT files so don't save them as word processor documents or save them with extentions such as .txt or they will NOT WORK.   Note that there may be a some files inside of folders which are "blank".   This is normal.

Preparing the CGI scripts

Define Path To PERL 5

The first step is to open up each and every file that has a .cgi extention and edit line number one of each script.  Each of the cgi scripts is written in perl 5. For your scripts to run they must know where perl 5 is installed on your web server. The path to perl 5 is defined to a cgi script in the first line of the file. In each of the cgi scripts the first line of code looks something like this:

#!/usr/bin/perl

If the path to perl 5 on your web server is different from /usr/bin/perl you must edit the first line of each cgi script to reflect the correct path. If the path to perl 5 is the same no changes are necessary. If you do not know the path to perl 5 ask the webmaster or system administrator at your server site.  

Configure the .cgi files

configure.cgi

This file pretty much runs the whole show.  If you screw this one up don't count on anything working properly.   In other words, make sure you take the time to do this step CORRECTLY.  Ask your administrator if you need to.  Below are the variables used in ALL of the other cgi scripts.  All of the other cgi programs USE configure.cgi to figure out where certain things are.


$stoplog = "250";

Used to set a maximum value for the number of lines of chat the server will track at any given time

$expire = 1000;

Sets the maximum time value a line of chat will be stored on the server

$chaturl = "/demo/superchat/superchat.html";

Full URL to superchat.html on your webserver

$chatlog = "/path/to/cgi-bin/superchat/log";

FULL PATH to slog on your webserver

$serverlog = "/path/to/cgi-bin/superchat/slog";

FULL PATH to slog on your webserver

$sendurl = "http://yourdomain.com/cgi-bin/superchat/send.cgi";

Full URL to send.cgi on your webserver

$geturl = "http://yourdomain.com/cgi-bin/superchat/get.cgi";

Full URL to get.cgi on your webserver

Upload Your Edited CGI and HTML Files

  • Upload all of the cgi files (.cgi) into a directory you create called "superchat" inside your cgi-bin
  • Create a directory inside your HTML space called superchat and upload index.html and superchat.html making sure you have edited the FORM ACTION fields first.

File Access Permissions

File access permissions must be set correctly for this program to run. The table below lists the permissions of each file which are to be set by the unix command ( chmod ) used to set the correct access permissions. You must set the access permissions for each of these files.

 CHMOD 755

 CHMOD 777

  • send.cgi
  • get.cgi
  • login.cgi
  • getrooms.cgi
  • slog
  • log