FM SiteSearch Pro Documentation
Installation
1.1 Requirements to run Fm SiteSearch Pro
1.2 Lunix/Unix Installation instructions
1.3 Windows Installation instructions
1.4 Final Installation Notes
1.5 Mysql Notes
1.6 Upgrade Instructions
1.1 Requirements
The requirements are those that most CGI scripts in general will require. What is required to run FM SiteSearch Pro?
-
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:
http://www.yourdomain.com/cgi-bin
-
Perl Ver 5+
-
FTP access to transfer files and to set permissions of files and directories.
-
Linux/Unix, or Windows based host/server
-
Mysql (Optional but recommended for web sites with thousands of pages - You can switch to Mysql at any time)
1.2 Installation Instructions
The installation of FM SiteSearch Pro 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 FM SiteSearch Pro 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 lines. The reason for it being a lot of text, is that we are trying to cover all possible situations when doing the setup and to explain it thoroughly to avoid any setup problems.
Step 1. (Extract the .zip archive)
Extract the files with their directories that came in the .zip archive.
Step 2. (Create a 'data' directory on your host/server)
Create a directory on your server/host called 'data' or whatever you would like to name it. This directory will be used to store all data files. This directory will contain files with various search settings, templates, etc.
A good location for this directory is somewhere where the web server cannot access it. Another way of saying this, is to say that you need to create the 'data' directory somewhere where a visitor to your web site cannot access the contents of this directory.
This means that you must not place/create this directory in your cgi-bin or public HTML document directory.
A good place to place this directory would be for example:
/home/yourdomain.com/data
where your cgi-bin directory will reside in something like
/home/yourdomain.com/www/cgi-bin
and your public HTML directory in something like
/home/yourdomain.com/www
Step 3. (Copy files to the 'data' directory)
The .zip archive will contain directories inside it. These directories are 'cgi', 'data' and 'html'
Now copy the files inside the 'data' directory of the .zip archive to the 'data' directory you have just created.
Step 4. (Set permissions of the 'data' directory and files within it)
Assign the permissions of 777 to the data directory and all the files residing in it.
4.1 How to set permissions from your ftp client/program:
Most FTP clients have the ability to set file permissions. Go to the 'data' directory where the 'data' files resides, and select the files. In your FTP client there should be a menu item or button where you change the file attributes or file permissions. Set the permissions/attributes of the files to 777. Also set the data directory you have created to the permission setting of 777.
4.2 How to set permissions from telnet or SSH
If your host/server disallows permissions to be set from ftp, you might want to take this route. Telnet/SSH into your hosting account/server and go to the 'data' directory where you copied the 'data' files. chmod 777 the files by issuing the following command from the command prompt:
chmod 777 *
Also set the directory to the permission setting of 777
For example:
chmod 777 somedatadir
Step 5. (Copy files to your cgi-bin directory)
The .zip archive will contain directories inside it. These directories are 'cgi', 'data' and 'html'
Copy the files in the 'cgi' directory to your 'cgi-bin' directory. You could place the files in for example: http://www.yourdomain.com/cgi-bin/fmsearch
Step 6. (Set permissions of the .cgi and .pm script files)
Set the permissions of the .cgi and .pm files to the permission setting of 755.
7.1 How to set permissions from your ftp client/program:
Most FTP clients have this ability. Go to the cgi-bin directory where the main .cgi and .pm script files resides. Select the files that you just copied. In your FTP client there should be a menu item or button where you change the file attributes or file permissions. Set the permissions/attributes to 755.
7.2 How to set permissions from telnet or SSH
If your host/server disallows permissions to be set from ftp, you might want to take this route.
Telnet/SSH into your hosting account/server and go to the cgi-bin directory where you copied the .cgi and .pm files. chmod 755 the files by issuing the following command from the command prompt:
chmod 755 *.cgi
Step 7. (Set config.cfg to the permission setting of 777)
Assign the permission setting of 777 to config.cfg - config.cfg is one of the files that you copied into your cgi-bin directory as explained in the above step.
Step 8. (Create an 'images' directory)
With the files/directories you extracted from the .zip archive there should have been a directory called 'images'.
On your hosting account/server create a directory called 'image' or whatever you would like to call it. This directory has to be in your public html document tree. Your public html document tree is where you store the web pages of your web site.
Now you should have created the 'images' directory. Copy the contents of the 'images' directory you have extracted from the installation .zip archive to the 'images'
directory you have created.
Step 9. (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 copied the .cgi and .pm files.
It should be located at, for example:
http://www.yourdomain.com/cgi-bin/fmsitesearch/setup.cgi
1.3 Windows Installation Instructions
The installation of FM SiteSearch Pro should be painless. Every measure has been taken to ensure that you get it right the first time.
Follow the steps below exactly as described and you should have FM SiteSearch Pro 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 lines. The reason for it being a lot of text, is that we are trying to cover all possible situations when doing the setup and to explain it thoroughly to avoid any setup problems.
Step 1. (Extract the .zip archive)
Extract the files with their directories that came in the .zip archive.
Step 2. (Edit CGI files)
When you extracted the contents of the .zip archive there should have been a 'cgi' directory extracted. Open each .cgi and the one .pm file with a unix compatible text editor. (even if the file is in unix file format it will run on windows) - Open the files with something like TextPad (http://www.textpad.com)
In each file there is text reading like this:
### WINDOWS USERS EDIT BELOW ##############################################
$cfile = "config.cfg";
#$cfile = "e:/Inetpub/webpub/cgi-bin/fms/config.cfg";
###################################################################
Edit the lines above so that it looks like this:
### WINDOWS USERS EDIT BELOW ##############################################
#$cfile = "config.cfg";
$cfile = "e:/your/full/server/path/to/config.cfg";
####################################################################
Replace e:/your/full/server/path/to/config.cfg above with your full server path to config.cfg
Do this with all the .cgi files and the one .pm file.
Step 3. (Create a 'data' directory on your host/server)
Create a directory on your server/host called 'data' or whatever you would like to name it. This directory will be used to store all data files. This directory will contain files with various search settings, templates, etc.
A good location for this directory is somewhere where the web server cannot access it. Another way of saying this, is to say that you need to create the 'data' directory somewhere where a visitor to your web site cannot access the contents of this directory.
This means that you must not place/create this directory in your cgi-bin or public HTML document directory.
A good place to place this directory would be for example:
e:/home/yourdomain/data
where your cgi-bin directory will reside in something like
e:/home/yourdomainwww/cgi-bin
and your public HTML directory in something like
e:/home/yourdomain/www
Step 4. (Copy files to the 'data' directory)
The .zip archive will contain directories inside it. These directories are 'cgi', 'data' and 'html'
Now copy the files inside the 'data' directory of the .zip archive to the 'data' directory you have just created.
Step 5. (Copy files to your cgi-bin directory)
The .zip archive will contain directories inside it. These directories are 'cgi', 'data' and 'html'
Copy the files in the 'cgi' directory to your 'cgi-bin' directory. You could place the files in for example: http://www.yourdomain.com/cgi-bin/fmsearch
Step 6. (Create an 'images' directory)
With the files/directories you extracted from the .zip archive there should have been a directory called 'images'.
On your hosting account/server create a directory called 'image' or whatever you would like to call it. This directory has to be in your public html document tree. Your public html document tree is where you store the web pages of your web site.
Now you should have created the 'images' directory. Copy the contents of the 'images' directory you have extracted from the installation .zip archive to the 'images' directory you have created.
Step 9. (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 copied the .cgi and .pm files.
It should be located at, for example:
http://www.yourdomain.com/cgi-bin/fmsitesearch/setup.cgi
1.4 Final Installation Notes
When you have completed the installation, log into the control panel and change the search settings so that it suites your needs. It would be a good idea to look at all settings in the control panel and to set them according to your preferences. There are many functions and options available which is thoroughly explained in the rest of the documentation.
If you are going to use a search index, you will need to build a search index before your web site can be searched. If any of the contents of your web site changes, you will need to rebuild the search index to reflect the changes.
1.5 Mysql Notes
If you are going to use Mysql you just need to choose that you are going to use mysql from setup.cgi - You will also need to supply a database name, database user name and password.
If you decide to switch to Mysql at a later stage you may do so at any time. Please note that the search box HTML code will change and fmsearch2.cgi will be used for searches instead of fmsearch.cgi
1.6 Upgrade Instructions
Upgrading your copy of FM SiteSearch Pro should be painless. Follow the instructions as you read through them below. Upgrading basically involves replacing all old .cgi and .pm files with the new .cgi and .pm files that comes with the new version.
If your copy of FM SiteSearch is registered, it will stay registered even if you upgraded it with the shareware version.
Step 1. (Extract the .zip archive)
Download the shareware version of FM SiteSearch Pro and extract the files with their directories that came in the .zip installation archive archive.
Step 2. (Replace all .cgi and .pm files)
The .zip installation archive will contain directories inside it. These directories are 'cgi', 'data' and 'html'
Copy the files in the 'cgi' directory to your 'cgi-bin' directory replacing the old .cgi and .pm files of FM SiteSearch Pro.
CAUTION: Do not replace the config.cfg of your FM SiteSearch Pro installation. This file will be located amongst the .cgi and .pm files inside your cgi-bin directory where the .cgi and .pm files of FM SiteSearch Pro resides.
Step 3. (Set permissions of the .cgi and .pm script files)
Skip this step if your host is Windows based.
Set the permissions of the .cgi and .pm files that you replaced to the permission setting of 755.
Step 4. (Run setup.cgi)
Load up setup.cgi in your browser and go through the setup steps to verify your installation.
Step 5. (Re-register)
If you are a registered user of FM SiteSearch Pro re-register your copy. To do this follow the registration instructions you received when you registered FM SiteSearch Pro.
|
