GuestFriend >> Documentation
1.1 Web Hosting Requirements
1.2 Installation Instructions
1.3 How to use GuestFriend
1.4 How to Customize The Look and Feel
The requirements are those that most CGI scripts in general will require.
Your own standard cgi-bin directory.
This is the directory where the cgi scripts are executed from. An example of a standard cgi-bin directory:
Perl Ver 5+
FTP access to transfer files and to set permissions of files and directories.
Linux/Unix based web host/server
If you are new to CGI Scripts or don't know what it is, click here to find out.
1.2 Installation Instructions
The installation of GuestFriend should be painless. Every measure has been taken to ensure that you get it right the first time. You don't have to edit any files, and only need to supply information via a setup interface.
Follow the steps below exactly as described and you should have GuestFriend serving you in a couple of minutes. Do the steps as you read through them. The setup instructions looks lengthy but it could actually have been explained in a couple of short lines. The reason for it being a lot of text, is that we are trying to cover all possible situations when doing the setup.
Step 1. (Extract the .zip archive)
Extract the files with their directories that came in the .zip archive.
Step 2. (Create a directory in your public HTML directory)
Create a directory called 'guestfriend' or anything else you would like to call it inside your public HTML directory. This directory will hold data and image files.
Step 3. (Transfer data and image files to the the directory created in step 2)
The installation .zip archive will contain directories inside it. These directories are 'cgi', and 'html'
Now transfer the files inside the 'html' directory of the .zip archive to the directory you created in step 2.
Step 4. (Set permissions of the directory created in step 2)
Assign the permissions of 777 to the directory you created in step 2 and all the files residing in it. If you don't know how to set permissions then click here to find out.
Step 5. (Transfer files to your 'cgi-bin' directory)
The .zip archive will contain directories inside it. These directories are 'cgi', and 'html'
Transfer the files in the 'cgi' directory of the .zip installation archive to your 'cgi-bin' directory. You could place the files in for example: http://www.yourdomain.com/cgi-bin/guestfriend/
Step 6. (Set permissions of the script files inside the 'cgi-bin' directory)
Set the permissions of the .cgi and .pm files transferred in step 6 to the permission setting of 755. If you don't know how to set permissions then click here to find out.
Step 7. (Set config.cgi to the permission setting of 777)
Assign the permission setting of 777 to config.cgi - config.cgi is one of the files that you transfered into your cgi-bin directory in step 4. If you don't know how to set permissions then click here to find out.
Step 8. (The setup interface)
Load setup.cgi in your browser and follow the instructions from there. setup.cgi is in your 'cgi-bin' directory where you have transferred the .cgi and .pm files as explained in step 5.
It should be located at, for example:
1.3 How to Use GuestFriend
After GuestFriend has been installed then you may get the hyperlink to the Guestbook by copying and pasting the link from the 'Goto Guestbook' tab into a web page.
Entries can be deleted or edited when clicking the 'Manage Entries' tab. There are also some settings that can be configured when clicking the 'settings' tab.
1.4 How to customize the look and feel
Go to the 'Template Manager' by clicking on the 'Template Manager' tab located in the Admin Control Panel. After that click on any of the three templates listed. You may also open the HTML files with your web editor to edit the templates.
Please ensure that the variables in the HTML code remains intact. The variable names are surrounded by the !! characters. These variables are replaced with data provided by GuestFriend, when visitors view the Guestbook and post Guestbook entries.
Note that when you make use of images in the html code, you must use a URL link to indicate their locations. For example:
<img src="someimage.gif"> will not work. You have to indicate the entire URL
where someimage.gif is located. For example:
The templates in GuestFriend are normal HTML files which you can edit with your web editor. The only difference between normal HTML files and the GuestFriend template HTML files is that the HTML used by GuestFriend requires the variable words in it.