CGI City's CC Goodbye
Installation Manual

File Info
This is the installation manual for CGI City's CC Goodbye.
Author/Programmer: Peter N. Go
Last Update - 07/25/99

Copyrights and Registration
CC Goodbye is © 1999-2099 CGI City. All rights reserved.
This script may be used freely on non-commercial/non-profit web sites. Usage of this script on commercial web sites requires a small registration fee of $15.

The user(s) must not remove the copyright notices on all accompanying files.

Disclaimer
In no event will CGI City be liable to the user of this script or any third party for any damages, including any lost profits, lost savings or other incidental, consequential or special damages arising out of the operation of or inability to operate this script, even if user has been advised of the possibility of such damages.

What is CC Goodbye
CC Goodbye is a redirection program written in Perl. It allows you to take visitors on your site to a "goodbye" page whenever they click on an external link prior to redirecting them to the actual link they clicked on. It has a logging feature which stores all clicks onto an HTML file which you can use to see which of your site's links are getting the most clicks.

Requirements
In order to successfully run CC Goodbye on your web server, you must

  • have at least some basic knowledge of HTML and Perl editing;
  • have some knowledge of what a text editor is and how to use one;
  • have a good understanding of transferring files from your PC to a web server;
  • have a web server running a Unix operating system (example: Linux);
  • have access to a cgi-bin. You can ask your web host if your account has cgi-bin access.
If you do not have either of these features, you cannot run this program.

Installing CC Goodbye
FILES - the ZIP file you downloaded should contain these files:

  1. cc_goodbye.cgi - a cgi program that takes your visitors to the goodbye page before redirecting them to an external link;
  2. log_reset.cgi - a cgi program that resets your log file if and when it gets too big;
  3. config.dat - a configuration file which determines the features and behaviors of CC Goodbye;
  4. log.html - an HTML file where all the clicks are logged;
  5. links.html - a sample HTML file with sample links;
  6. survey.html - a sample HTML file used as an "alternative page";
  7. installation.html - this file;
  8. bgd.gif - sample background image file.

EDITING FILES - always use a text editor like Notepad or Textpad (never, never use an HTML editor/generator) when editing the following files:

  1. cc_goodbye.cgi and log_reset.cgi - edit only the very first line of this file. Change it to point correctly to your web server's Perl interpreter. It's usually in this format:
    #!/usr/bin/perl or
    #!/usr/local/bin/perl
    If you are not sure about this, please verify with your web host administrator.
  2. config.dat - open this file with a text editor and edit it according to the instructions found within the file itself. There are several variables you can modify to configure the program according to your needs. Each variable has a brief explaination within the file.
  3. links.html - edit the links to point correctly to where you installed your copy of CC Goodbye on your server. See Using The Program section for further instruction on modifying your external links.

UPLOADING FILES - once you have correctly edited the files mentioned in the previous segment, you are ready to upload them to your web server. You need to upload them using an ftp program like WSFtp or CuteFTP. To upload, simply ftp the following files to your server:
FILENAME FTP MODE
cc_goodbye.cgi ASCII
log_reset.cgi ASCII
config.dat ASCII
log.html ASCII
links.html ASCII
survey.html ASCII
installation.html ASCII

DIRECTORY TREE & CHMOD'ING FILES - here is a sample directory tree you can pattern after (with the corresponding chmod values; no chmod value means leave as-is):

YOUR ROOT DIRECTORY
          |____CGI-BIN directory (chmod 755)
          |       |____CC GOODBYE Sub-directory (chmod 755)
          |                  |
          |                  |____cc_goodbye.cgi (chmod 755)
          |                  |____log_reset.cgi (chmod 755)
          |                  |____config.dat (chmod 755)
          |
          |____HTML Sub-directory (this is where your HTML files are located)
                  |
                  |____CC GOODBYE Sub-directory (chmod 777)
                             |
                             |____links.html 
                             |____log.html (chmod 777)
                             |____survey.html 
                             |____bgd.gif 

Using the Program
In order to use CC Goodbye, you need to modify your external links. Typically, an external link in your HTML file would look something like this:
<A HREF="http://icthus.net/CGI-City/">CGI CITY</A> - typical link example.

All extrenal links need to be modified in order for them to use the CC Goodbye program. A link that uses CC Goodbye looks something like this:
<A HREF="http://yoursite.com/cgi-bin/cc_goodbye.cgi?CGI_City::http://icthus.net/CGI-City/">CGI CITY</A>

OK, let's take that a piece at a time. The example has been color coded to make it easier to follow. Notice the letters in blue are the very same HTML tags used in the first (typical link) example.

The part in green is the URL to where you placed your CC Goodbye program.

It is then followed by a question mark like this >> ?

Then the part in orange is the name of the external link. Note that you need to use an underscore like this "_" in between the words if your external link has more than one word. So if your external link is called Free Downloads, you have to connect the 2 words with the underscore like this >> Free_Downloads.

The next part is a pair of semi-colons like this >> ::

And the final part in purple is the actual URL of the external link.

That's all there is to it.

The Alternative Page
When a visitor clicks on an external link and is taken to your "goodbye" page, the visitor should see a message that goes like this:

Thank you for visiting Site Name.
In a few seconds, you will be redirected to
Title of Clicked Link
Or you may opt to take our survey.

The part in blue is the hyperlink to your alternative page. Depending on how you configure the config.dat file, you can either have one or none at all.

Contacting Us
Report any bugs or send feedback to: CGI City

Disclaimer [ Again ]
In no event will CGI City be liable to the user of this script or any third party for any damages, including any lost profits, lost savings or other incidental, consequential or special damages arising out of the operation of or inability to operate this script, even if user has been advised of the possibility of such damages.


CC Goodbye - © 1999-2099 CGI City - All rights reserved.