Quick Install/Upgrade

For those who want to just get down to it....

Download your chosen format to the server, then decompress the archive file.
In the following example I assume the user shall be 'admin' and the group shall be 'home' - change as you require.

chown admin.home summarizer.cgi summarizer.ico
chmod 755 summarizer.cgi
chmod 644 summarizer.ico

Thats it, its now installed, though you should ensure that the site does have CGI/perl enabled.
Now skip to the Configuration and Customisation Section.

Detailed Install/Upgrade

Installation Methods

'Summarizer' is available for download in a number of different formats, and each is described below and their installation, choose the one most appropriate to you needs.

Available formats

1. Cobalt/Sun Installer Package (.pkg) format (RaQ3 & RaQ4 Compatible)
   


2. BZip2 (.bz2) format - supported by most *NIX systems 'out of the box' - HIGHLY compressed archive
   


3. Compressed Tar Archive (.tar.gz) format - the common *NIX format
   


4. Compressed Zip (.zip) format (Windows/DOS) - Useful if you want to see/edit the files on Windows type platforms first
   


5. Plain Text (.txt) format &
   FavIcon (.ico) format (summarizer.ico)
   

Confirming the Archive file's Integrity

Also I have generated Md5Sums of all of the above files should you want to confirm that the file has transfered correctly and is not corrupt.
You can confirm this by also downloading the m5sum file, and ensuring it is placed in the same directory, then from your shell prompt type (e.g. for confirming the BZip2 file format is not corrupt):

md5sum -c summarizer.tar.bz2.md5

summarizer.tar.bz2: OK

Getting & Decompressing the Archive file

1. Cobalt/Sun Installer Package - Decompressing is NOT required - Skip to the next section!!
   


2. BZip2 (.bz2) format - a simple:

   cd /the/site/your/want/this/installed/in
   wget http://scripts.akakul.co.uk/summarizer/files/summarizer.tar.bz2
   bunzip2 summarizer.tar.bz2

   will decompress the files (see further down for the 'common' installation
   


3. Compressed Tar Archive (.tar.gz) format - a simple:

   cd /the/site/your/want/this/installed/in
   wget http://scripts.akakul.co.uk/summarizer/files/summarizer.tar.gz
   tar -zxf summarizer.tar.gz

   will decompress the files (see further down for the 'common' installation
   


4. Compressed Zip (.zip) format (Windows/DOS) - a simple:

   cd /the/site/your/want/this/installed/in
   wget http://scripts.akakul.co.uk/summarizer/files/summarizer.zip
   unzip summarizer.zip

   will decompress the files (see further down for the 'common' installation
   


5. Plain Text (.txt) format - a simple ftp(etc) of this file to the destination machine (along with the .ico file) - This .cgi file is written in *NIX format and does NOT need to be transferred in ASCII mode (though ASCII FTP will not dammage/harm it)
   

Installing the files

1. Cobalt/Sun Installer Package - This can be installed from the GUI interface as you would any normal .pkg. This also will deal happily with subsequent upgrades...they do NOT need to be un-installed first, an subsequent installation of a latter version is automatically treated as an Upgrade, with the previous version being removed during the new installation.
   Alternativly you can install this .pkg from the command line if you wish...(ensure you are logged in as 'root')
   

   /home/local/sbin/cobalt_upgrade RAQ3-4.Summarizer-1.4.2.pkg

   You should also make sure that the site (home) has CGI enabled in the GUInterface.


2. BZip2 (.bz2) format - see below
   


3. Compressed Tar Archive (.tar.gz) format - see below
   


4. Compressed Zip (.zip) format (Windows/DOS) - see below
   


5. Plain Text (.txt) format - see below
   

Installing the files for ii, iii, iv and v (above) is identicle from this point on

NOTE: You should install this CGI script in a directory is protected from prying eyes (e.g. use .htaccess)

Setting up the script is extreemly simple, first ensure that you have BOTH files 'summarizer.cgi' and 'summarizer.ico' in the current directory.
You will need to known the UID/GID if you have transferred this as a user other than the one whom ownes the site you are about to install it in.
In the following example I assume the user shall be 'admin' and the group shall be 'home' - change as you require.

chown admin.home summarizer.cgi summarizer.ico
chmod 755 summarizer.cgi
chmod 644 summarizer.ico

Thats it, its now installed, though you should ensure that the site does have CGI/perl enabled

Configuration and Customisation of the 'summarizer.cgi' script

See the Support Docs section for the various customisations for summarizer.cgi

Should you ever need to remove the package

These instructions show how to delete/remove the package/software completly from your system. If you have made changes to any other pages/scripts on your system, you will need to also altere those.
NOTE: It is NOT necassary to delete the current installtion if you are upgrading to a newer version, just install over the top, and dotn forget to update the 'cache' the first time you use it.

1. Cobalt/Sun Package - This can only be done from Telnet/SSH, ensure you are logged in as 'root'
   

   cd /var/lib/cobalt/uninstallers/
   sh Summarizer-1.4.2.uninst

   Dont forget to alter the version number to the one you have isntalled!
   


2. BZip2 (.bz2) format - see below
   


3. Compressed Tar Archive (.tar.gz) format - see below
   


4. Compressed Zip (.zip) format (Windows/DOS) - see below
   


5. Plain Text (.txt) format - see below
   

Removing the files for ii, iii, iv and v (above) is identicle from this point on
From SSH/Telnet

cd /the/site/you/installed/it/in
rm summarizer.cgi summarizer.ico

You will also need to delete the 'summarizer.cache' file, which is by default stored one directory below the document root of the site it is installed on (below the web/public_html directory). You may also want to delete the original Archive file you downloaded.
Or delete the 3 files using FTP if you prefer