USTCP cgiSuite Documentation

Index:

• cgiSuite Administrative Module Installation (cgiadmin.pl)
• cgiSuite Feedback Form Handler Installation (mfadmin.pl, mailform.pl)
• cgiSuite Redirector Handler Installation (rdradmin.pl, redirect.pl)

Installing to a UNIX Platform

First, if you do not already know the proper path to the most current version of Perl 5.xxx then now is the time to call or email your ISP and find out. Specifically, let them know that you need to know what the very first line of a Perl script should look like to execute properly on their server.

The Line will look something like:

#!/usr/bin/perl

Note the "#!" preceding the full path to the perl executable. Now use your favorite text editor (e.g. Windows Notepad, WordPad, vi, etc.) to edit the first line in cgiadmin.pl to reflect your ISP’s perl configuration. This step is very important, if this line is incorrect, the script will not execute and you will get an often meaningless error reported to you by the web server! If you are not certain of the correct path and have telnet access you may type "which perl" at the command line to learn the path. Be aware that some providers may have multiple versions of Perl installed, in which case the version you will want may be in a path called "perl5". Ask your ISP if in doubt!

Note to Mac Users: Please try to use a Windows, DOS, or UNIX machine to edit the Perl script. The Macintosh platform has a tendency to alter the end of line character in the script to a format not recognized by either Windows or UNIX systems. If you must edit the script on a Macintosh, please take extra special care to make sure the edited file is exported as an MS DOS Text file!

Next, decide whether you wish to install this script directly into your cgi-bin (or equivalent) directory, or into its own subdirectory. We recommend creating a subdirectory under cgi-bin by the name of cgisuite, such that the location of this script from your web root directory is /cgi-bin/cgisuite. All of our examples will be based upon this configuration.

Change to your cgi-bin directory by executing the following command from your root directory:

cd cgi-bin

Create the cgisuite subdirectory by executing the following command:

mkdir cgisuite

Now chmod the /cgi-bin/cgisuite directory with 777 permissions (read, write, and execute) with the following command:

chmod 777 cgisuite

Now change to the /cgi-bin/cgisuite directory with the following command:

cd cgisuite

FTP the following files to your /cgi-bin/cgisuite directory as ASCII (Text) by typing "ascii" on the command line and then ‘putting’ the following files:

put cgiadmin.pl
put cgisuite.mod
put Snefru.pm   (Note the capital ‘S’)

Now chmod each file as follows:

chmod 755 cgiadmin.pl
chmod 644 cgisuite.mod
chmod 644 Snefru.pm   (Note the capital 'S')

Now it is time to install the supporting image files. Perform a change directory to the root directory of your website (usually the same directory where your entry homepage is located). If you ftp directly into your root directory the command is probably "cd /", otherwise it may be of the form "cd /home/www.you.com/" or the like.

Create a subdirectory of /cgisuite/images with the following commands:

mkdir cgisuite
cd cgisuite
mkdir images
cd images

You should now have a directory of /cgisuite/images that can be called via http://www.yoursite.com/cgisuite/images if everything has been configured properly. Now it’s time to upload the image files and set their permissions!

FTP the following files to the /cgisuite/images directory as BINARY by typing "binary" on the command line and then ‘putting’ the following files:

put acctman.gif
put cgilogo.gif
put copyfoot.gif
put defparam.gif
put glmanhd.gif
put loginout.gif
put logman.gif
put modmanhd.gif
put resettim.gif
put vieweula.gif

Now set read permissions on all these files by chmod 644 (read permissions) all of them with the following command:

chmod 644 *

You are now ready to proceed to the Configuration portion of the application.  To configure this application, simply call the cgiadmin.pl script (e.g. http://www.yoursite.com/cgi-bin/cgiadmin.pl)

For more information on configuring and using this application, please refer to  the USTCP cgiSuite User's Manual (PDF).

 

Installing to a Windows NT Platform

First decide whether you wish to install this script directly into your cgi-bin (or equivalent) directory, or into its own subdirectory. We recommend creating a subdirectory under cgi-bin by the name of cgisuite, such that the location of this script from your web root directory is /cgi-bin/cgisuite. All of our examples will be based upon this configuration.

Create the cgisuite subdirectory by executing the following command:

mkdir cgisuite

FTP the following files to your /cgi-bin/cgisuite directory as ASCII (Text) by typing ‘ascii’ on the command line and then ‘putting’ the folloiwng files:

put cgiadmin.pl
put cgisuite.mod
put Snefru.pm (Note the capital ‘S’)

Call or email your ISP and make sure that they have enabled "CHANGE" permissions for the Anonymous Web User for your cgi-bin directory, if they have not, tell them you need to have "CHANGE" permissions enabled on your /cgi-bin/cgisuite directory. This permits the script to write to files as well as create new files and directories. If you get any permissions related errors while trying to save your initial configuration information, be suspicious that "CHANGE" permissions have not been enabled!

Now it is time to install the supporting image files. Perform a change directory to the root directory of your website (usually the same directory where your entry homepage is located).

Create a subdirectory of /cgisuite/images with the following commands:

mkdir cgisuite
cd cgisuite
mkdir images
cd images

You should now have a directory of /cgisuite/images that can be called via http://www.yoursite.com/cgisuite/images if everything has been configured properly. Now it’s time to upload the image files!

FTP the following files to the /cgisuite/images directory as BINARY by typing ‘binary’ on the command line and then ‘putting’ the following files:

put acctman.gif
put cgilogo.gif
put copyfoot.gif
put defparam.gif
put glmanhd.gif
put loginout.gif
put logman.gif
put modmanhd.gif
put resettim.gif
put vieweula.gif

You are now ready to proceed to the Configuration portion of the application.  To configure this application, simply call the cgiadmin.pl script (e.g. http://www.yoursite.com/cgi-bin/cgiadmin.pl)

For more information on configuring and using this application, please refer to  the USTCP cgiSuite User's Manual (PDF).

Installing to a UNIX Platform

First, if you do not already know the proper path to the most current version of Perl 5.xxx now is the time to call or email your ISP and find out. Specifically, let them know that you need to know what the very first line of a Perl script should look like to execute properly on their server.

The Line will look something like:

#!/usr/bin/perl

Note the "#!" preceding the full path to the perl executable. Now use your favorite text editor (e.g. Windows Notepad, WordPad, vi, etc.) to edit the first line in mailform.pl to reflect your ISP’s perl configuration. This step is very important, if this line is incorrect, the script will not execute and you will get an often meaningless error reported to you by the web server!

Note to Mac Users: Please try to use a Windows, DOS, or UNIX machine to edit the Perl script. The Macintosh platform has a tendency to alter the end of line character in the script to a format not recognized by either Windows or UNIX systems. If you must edit the script on a Macintosh, please take extra special care to make sure the edited file is exported as an MS DOS Text file!

Next, the script files for this Add-on Module should be installed in the same CGI directory as you installed the Administrative Module. If you have not already installed the Administrative Module, please go back and do so at this time before proceeding.

We recommended installing the Administrative Module in its own directory, specifically we recommended a directory structure similar to: /cgi-bin/cgisuite. All of our examples will be based upon this configuration. If you installed your Administrative Module to a different directory, please substitute that directory where applicable in these instructions.

Now change to the /cgi-bin/cgisuite directory with the following command:

cd cgi-bin/cgisuite

FTP the following files to your /cgi-bin/cgisuite directory as ASCII (Text) by typing "ascii" on the command line and then ‘putting’ the following files:

put mailform.pl
put mfadmin.pl
put Perlmail.pm  (Note the capital ‘P’)

Now chmod each file as follows:

chmod 755 mailform.pl
chmod 644 mfadmin.pl
chmod 644 Perlmail.pm  (Note the capital ‘P’)

Now it is time to install the supporting image file. Perform a change directory to the root directory of your website (usually the same directory where your entry homepage is located).

When you performed your installation of the Administrative Module, we recommending installing the images in a directory named /cgisuite/images located under the root directory of your website. All of our examples are based upon this assumption. If you installed to a different directory, please make the appropriate substitutions in the instructions below.

Create a subdirectory of /cgisuite/images/mailform with the following commands:

cd cgisuite/images
mkdir mailform
cd mailform

Now chmod the mailform images directory for read-only anonymous permissions with the following command:

chmod 644 .   (This chmod’s the current directory)

You should now have a directory of /cgisuite/images/mailform that can be called via http://www.yoursite.com/cgisuite/images/mailform if everything has been configured properly. Now it’s time to upload the image files and set their permissions!

FTP the following file to the /cgisuite/images/mailform directory as BINARY by typing "binary" on the command line and then ‘putting’ the following file:

put mailform.gif

Now set read-only anonymous permissions on this file with chmod 644 (read permissions) using the following command:

chmod 644 *   (This will chmod every file in the current directory)

You are now ready to proceed to the Configuration portion of the application.  To configure this application, simply call the cgiadmin.pl script (e.g. http://www.yoursite.com/cgi-bin/cgiadmin.pl) and then click on the "Feedback Form" index option. The initial configuration screen will then be displayed the very first time this modules is run.

For more information on configuring and using this application, please refer to  the USTCP cgiSuite User's Manual (PDF).

 

Installing to a Windows NT Platform

First, the script files for this Add-on Module should be installed in the same CGI directory as you installed the Administrative Module. If you have not already installed the Administrative Module, please go back and do so at this time before proceeding.

We recommended installing the Administrative Module in its own directory, specifically we recommended a directory structure similar to: /cgi-bin/cgisuite. All of our examples will be based upon this configuration. If you installed your Administrative Module to a different directory, please substitute that directory where applicable in these instructions.

Now change to the /cgi-bin/cgisuite directory with the following command:

cd cgi-bin/cgisuite

FTP the following files to your /cgi-bin/cgisuite directory as ASCII (Text) by typing "ascii" on the command line and ‘putting’ the following files:

put mailform.pl
put mfadmin.pl
put Perlmail.pm  (Note the capital 'P')

Now it is time to install the supporting image files. Perform a change directory to the root directory of your website (usually the same directory where your entry homepage is located).

When you performed your installation of the Administrative Module, we recommending installing the images in a directory named /cgisuite/images located under the root directory of your website. All of our examples are based upon this assumption. If you installed to a different directory, please make the appropriate substitutions in the instructions below.

Create a subdirectory of /cgisuite/images/mailform with the following commands:

cd cgisuite/images
mkdir mailform
cd mailform

You should now have a directory of /cgisuite/images/mailform that can be called via http://www.yoursite.com/cgisuite/images/mailform if everything has been configured properly. Now it’s time to upload the image files and set their permissions!

FTP the following file to the /cgisuite/images/mailform directory as a BINARY by typing "binary" on the command line and then ‘putting’ the following file:

put mailform.gif

You are now ready to proceed to the Configuration portion of the application.  To configure this application, simply call the cgiadmin.pl script (e.g. http://www.yoursite.com/cgi-bin/cgiadmin.pl) and then click on the "Feedback Form" index option. The initial configuration screen will then be displayed the very first time this modules is run.

For more information on configuring and using this application, please refer to  the USTCP cgiSuite User's Manual (PDF).

 

Using the Feedback Form Handler 

To use the Feedback Form Handler module within your HTML Web page:

• Set the form "action" to point to the mailform.pl script (e.g. http://www.yoursite.com/cgi-bin/cgisuite/mailform.pl)
• Set a hidden variable named "FormName" (note the use of upper and lowercase characters, this variable is case-sensitive!) to reflect the name of the handler definition you have defined to handle the current HTML form.

or

• Use the HTML Include auto-generator option to create a customized template to be pasted into your web document. You may then add whatever form fields you wish to this template to complete your feedback form.

For more information on configuring and using this application, please refer to  the USTCP cgiSuite User's Manual (PDF).

 

Installing to a UNIX Platform

First, if you do not already know the proper path to the most current version of Perl 5.xxx now is the time to call or email your ISP and find out. Specifically, let them know that you need to know what the very first line of a Perl script should look like to execute properly on their server.

The Line will look something like:

#!/usr/bin/perl

Note the "#!" preceding the full path to the perl executable. Now use your favorite text editor (e.g. Windows Notepad, WordPad, vi, etc.) to edit the first line in redirect.pl to reflect your ISP’s perl configuration. This step is very important, if this line is incorrect, the script will not execute and you will get an often meaningless error reported to you by the web server!

Note to Mac Users: Please try to use a Windows, DOS, or UNIX machine to edit the Perl script. The Macintosh platform has a tendency to alter the end of line character in the script to a format not recognized by either Windows or UNIX systems. If you must edit the script on a Macintosh, please take extra special care to make sure the edited file is exported as an MS DOS Text file!

Next, the script files for this Add-on Module should be installed in the same CGI directory as you installed the Administrative Module. If you have not already installed the Administrative Module, please go back and do so at this time before proceeding.

We recommended installing the Administrative Module in its own directory, specifically we recommended a directory structure similar to: /cgi-bin/cgisuite. All of our examples will be based upon this configuration. If you installed your Administrative Module to a different directory, please substitute that directory where applicable in these instructions.

Now change to the /cgi-bin/cgisuite directory with the following command:

cd cgi-bin/cgisuite

FTP the following files to your /cgi-bin/cgisuite directory as ASCII (Text) by typing "ascii" on the command line and then ‘putting’ the following files:

put redirect.pl
put rdradmin.pl

Now chmod each file as follows:

chmod 755 redirect.pl
chmod 644 rdradmin.pl

Now it is time to install the supporting image file. Perform a change directory to the root directory of your website (usually the same directory where your entry homepage is located).

When you performed your installation of the Administrative Module, we recommending installing the images in a directory named /cgisuite/images located under the root directory of your website. All of our examples are based upon this assumption. If you installed to a different directory, please make the appropriate substitutions in the instructions below.

Create a subdirectory of /cgisuite/images/redirect with the following commands:

cd cgisuite/images
mkdir redirect
cd redirect

You should now have a directory of /cgisuite/images/redirect that can be called via http://www.yoursite.com/cgisuite/images/redirect if everything has been configured properly. Now it’s time to upload the image files and set their permissions!

Now chmod the mailform images directory for read-only anonymous permissions with the following command:

chmod 644 . (This chmod’s the current directory)

FTP the following file to the /cgisuite/images/redirect directory as BINARY by typing "binary" on the command line and then ‘putting’ the following file:

put redirect.gif

Now set read permissions on this file with chmod 644 (read permissions) using the following command:

chmod 644 * (This will chmod every file in the current directory)

You are now ready to proceed to the Configuration portion of the application.  To configure this application, simply call the cgiadmin.pl script (e.g. http://www.yoursite.com/cgi-bin/cgiadmin.pl) and then click on the "Redirector" index option. The initial configuration screen will then be displayed the very first time this modules is run.

For more information on configuring and using this application, please refer to  the USTCP cgiSuite User's Manual (PDF).

 

Installing to a Windows NT Platform

First, the script files for this Add-on Module should be installed in the same CGI directory as you installed the Administrative Module. If you have not already installed the Administrative Module, please go back and do so at this time before proceeding.

We recommended installing the Administrative Module in its own directory, specifically we recommended a directory structure similar to: /cgi-bin/cgisuite. All of our examples will be based upon this configuration. If you installed your Administrative Module to a different directory, please substitute that directory where applicable in these instructions.

Now change to the /cgi-bin/cgisuite directory with the following command:

cd cgi-bin/cgisuite

FTP the following files to your /cgi-bin/cgisuite directory as ASCII (Text) by typing "ascii" on the command line and then ‘putting’ the following files:

put redirect.pl
put rdradmin.pl

Now it is time to install the supporting image files. Perform a change directory to the root directory of your website (usually the same directory where your entry homepage is located).

When you performed your installation of the Administrative Module, we recommending installing the images in a directory named /cgisuite/images located under the root directory of your website. All of our examples are based upon this assumption. If you installed to a different directory, please make the appropriate substitutions in the instructions below.

Create a subdirectory of /cgisuite/images/redirect with the following commands:

cd cgisuite/images
mkdir redirect
cd redirect

You should now have a directory of /cgisuite/images/redirect that can be called via http://www.yoursite.com/cgisuite/images/redirect if everything has been configured properly. Now it’s time to upload the image files and set their permissions!

FTP the following file to the /cgisuite/images/redirect directory as a BINARY by typing "binary" on the command line and then ‘putting’ the following file:

put redirect.gif

You are now ready to proceed to the Configuration portion of the application.  To configure this application, simply call the cgiadmin.pl script (e.g. http://www.yoursite.com/cgi-bin/cgiadmin.pl) and then click on the "Redirector" index option. The initial configuration screen will then be displayed the very first time this modules is run.

For more information on configuring and using this application, please refer to  the USTCP cgiSuite User's Manual (PDF).

 

Using the Redirector Handler 

To use the Redirector Handler module within your HTML Web page:

• Use the HTML Include auto-generator option to create a customized template to be pasted into your web document. You will be able to choose from several SSI strategies (experiment, different web servers and operating systems require different approaches) which will dynamically build and include the HTML code into your web document, or you may opt for the statically generated code and paste the complete HTML source into your web document for better performance.

For more information on configuring and using this application, please refer to  the USTCP cgiSuite User's Manual (PDF).