corner1.gif (159 bytes) corner2.gif (159 bytes)

TurboSeek » TurboSeek Documentation >> 1. Installation


Turbo Seek Documentation

Index

1. Installation
2. Settings and Options (After installation)
3. The Directory Manager
4. How templates & their variables work
5. Building a Search Index
6. Running your directory
7. Tips, Tricks & Notes
8. Plug-In's

<< Previous Page
Index

Index

Next Page >>
Settings and Options

 

1. Installation

1.1 Installation
1.2 Overview of files in the .zip archive
1.3 Installation Trouble Shooter
1.4 Upgrading Your Copy
        1.4.1 Upgrading from ver 2.x
        1.4.2 Upgrading from ver 1.x
1.5 Uninstallation
1.6 How to create your search engine in just a few steps - Tutorial &
        1.6.1 (Step 1) Create Your Directory Structure
        1.6.2 (Step 2) Add Links To Your Directories
        1.6.3 (Step 3) Creating The Front Page of Your Search Engine & Directory
        1.6.4 Adding Search Capability to your Search Engine and Directory
        1.6.5 Notes On Running a HTML Generated Directory
        1.6.6 Final Notes on This Tutorial

 

1.1 Installation

A special setup interface has been created for easy setup. Follow the steps below exactly and you should have your own Search Engine and Directory up and running in a couple of minutes. Do the steps as you read through them. If it tells you to do something, do it straight away. This will ensure that you get it right the first time.

 

Step 1 - UNZIP THE .ZIP ARCHIVE IN WHICH TURBO SEEK CAME

Unzip the .zip file in which Turbo Seek came.

 

Step 2 - MAKE CHANGES TO SUPPORT MYSQL
(Skip this step if you are not going to use MySQL - you can also enable it at a later stage)

If you are going to use MYSQL uncomment the line '#use DBI;' in admin.cgi, admin4.cgi, tsearch.cgi and tmodify.cgi

You will need to open admin.cgi, admin4.cgi, tsearch.cgi and tmodify.cgi with a text editor that is capable of saving and opening files in unix file format. (An excellent text editor for the task is TextPad. You can download it here.)

To uncomment the line near the top reading:
#use DBI;
To uncomment this line remove the # character. It should then look like this when the line is uncommented:
use DBI;

 

Step 3 - TRANSFER CGI SCRIPTS & DATA FILES

When you unzipped the .zip archive of Turbo Seek, a 'cgi-bin' directory should have been extracted. Transfer all the files and directories in the cgi-bin directory to your cgi-bin directory on your server/hosting account.


movie.gif (975 bytes) Watch Video on how to do Step 3
  • Requires: Flash
  • File Size: 500 KB
  • Video Length: 1 minute 6 seconds

Step 4 - SET PERMISSIONS

FTP into your server/hosting-account and set the permissions of all the .cgi and .pm files to 755

Set the permission setting of a file called config.cgi to 777

The .cgi and .pm files are the files that was transferred in step 3 above.

Note that there is a sub directory called 'admin' - Also set the permission setting of all files in this directory to 755


movie.gif (975 bytes) Watch Video on how to do Step 4
  • Requires: Flash
  • File Size: 700 KB
  • Video Length: 56 seconds

 

Step 5 - SET UP THE SYSTEM FROM THE WEB

Run setup.cgi from your web browser. setup.cgi is located in the admin directory. (Under the cgi-bin directory)

You should type something like the example below to execute setup.cgi
http://www.yourdomain.com/cgi-bin/admin/setup.cgi

Follow the instructions that is displayed to you in your browser. setup.cgi is a
program that will configure Turbo Seek and check to ensure that your setup/installation is correct.

 

Final Setup/Installation Notes - Please Read

  • The control panel will require you to have cookies enabled in your browser if you want to use the built in password protection. If you do not want to password protect the control panel with the built in password protection, leave the user name and password fill-in box in setup.cgi blank. This can be useful if you want to password protect the directory where the admin .cgi scripts resides, with the web server.  

  • Read How to create your search engine in just a few steps - Tutorial & Overview - It is a short tutorial aimed at getting you started as fast as possible.  

  • The login of the Turbo Seek control panel will remember you for 24 hours. You only have to login once and the control panel will remember your login for the next 24 hours. After 24 hours you will have to supply the control panel user name and password again. In no way will anybody else have access to the control panel.
      

1.2 Overview of cgi script files in the .zip archive

/cgi
Holds the general script files used to operate the directory and search engine. Also holds setup.cfg that holds configuration variables.
   
/cgi/admin
Holds the script files used to operate the control panel.
   
/data
This directory holds various files used by Turbo Seek
   
/html
This directory holds images and other files used by Turbo Seek

 

1.3 Installation Trouble Shooter

Installation of Turbo Seek should go smoothly if you follow the installation instructions exactly as described in the installation steps.

Turbo Seek also comes with a setup debugger. This debugger should be able to tell you the problem. Execute setup.cgi as follows:
http://www.yourdomain.com/cgi-bin/admin/setup.cgi?fct=debug_setup

Trouble Shooting

1. Is the permissions of the 'data' directory 777 ?
To chmod the 'data' directory, do the following:

Step 1
Ftp into your hosting account.

Step 2
Set permissions of the 'data' directory to 777

2. Is the permissions of the files in the 'data' directory set to 777 ?

Step 1
Ftp into your hosting account.

Step 2
Set all the files that you transferred to the 'data' directory
to the permission setting of 777

3. Is the permissions for the 'html' directory correct?
If you are not going to use server side includes, this directory has to be chmod'ed to 777.

Advanced Users: If you are going to use server side includes on generated HTML pages you have to generate the HTML files from the Unix prompt. See Running an HTML generated directory

To assign/set permissions of 777 to the 'html' directory, do the following:

Step 1
FTP into your hosting account

Step 2
Set the permissions of the 'html' directory to 777

4. Does all the .cgi files have the correct permissions?
Ensure that all the .cgi and .pm script files have permissions set to 755 - Also make sure that config.cgi has the permission setting of 777

5. If you are using MYSQL, did you uncomment the 'use DBI;' line in admin.cgi, admin4.cgi and tsearch.cgi ?
To uncomment this line, do the following:

Uncomment the following line in admin.cgi, admin4.cgi and tsearch.cgi:
#use DBI;
To uncomment '#use DBI;' just remove the # character. It should then look like this:
use DBI;

 

1.4 Upgrading Your Copy

1.4.1 Upgrading From Ver 2.x

Follow these upgrade instructions if you have an existing Turbo Seek ver 2.x installed and you would like to install/upgrade to the latest version.

All your data and settings will stay in tact after the upgrade. We advise that you backup your data, templates and all settings before upgrading. See Data Backups for a detailed explanation of how to backup your data.

Step 1 - Skip This Step if you don't use Mysql

Unzip the .zip archive. Then open admin.cgi, admin4.cgi, tsearch.cgi and tmodify.cgi with a text editor by uncomment the line reading:
#use DBI;
to
use DBI;

To uncomment the line you remove the # character.

Note: Use a Unix compatible text editor like Textpad to open the .cgi files.

Step 2 - Transfer/Copy new .cgi and .pm files

Now copy/transfer, overwrite/replace the old .cgi and .pm files with the new .cgi and .pm files that came with the .zip archive. If there are additional .cgi and .pm files present in the .zip file, copy/transfer them into your cgi-bin directory. The .zip archive in which Turbo Seek came reflects the locations of the normal .cgi and .pm files and the admin .cgi files.

Important Note: Do not overwrite config.cgi with the one that comes with the .zip archive.

After you transferred the new .cgi and .pm files ensure that all the files you transferred has permissions of 755.

Set the permission setting of config.cgi to 777 - This file will be inside the cgi-bin directory.

Step 3 - Transfer image files

Now copy/transfer, overwrite/replace the old image files with the new image files that came with the .zip archive. The image files of Turbo Seek are located in the 'html' directory inside the .zip archive.

 

 

1.4.2 Upgrading From Ver 1.x

Follow these upgrade instructions if you have an existing Turbo Seek ver 1.x installed and you would like to install/upgrade to the latest version.

All your data and settings will stay in tact after the upgrade. We advise that you backup your data, templates and all settings before upgrading. See Data Backups for a detailed explanation of how to backup your data.

Step 1 - Skip This Step if you don't use Mysql

Unzip the .zip archive. Then open admin.cgi, admin4.cgi, tsearch.cgi and tmodify.cgi with a text editor by uncomment the line reading:
#use DBI;
to
use DBI;

To uncomment the line you remove the # character.

Note: Use a Unix compatible text editor like Textpad to open the .cgi files.

Step 2 - Transfer/Copy new .cgi and .pm files

Now copy/transfer, overwrite/replace the old .cgi and .pm files with the new .cgi and .pm files that came with the .zip archive. If there are additional .cgi and .pm files present in the .zip file, copy/transfer them into your cgi-bin directory. The .zip archive in which Turbo Seek came reflects the locations of the normal .cgi and .pm files and the admin .cgi files.

NOTE: Do not overwrite config.cgi with the one that comes with the .zip archive.

After you transferred the new .cgi and .pm files ensure that all the files you transferred has permissions of 755.

Step 3 - Transfer image files

Now copy/transfer, overwrite/replace the old image files with the new image files that came with the .zip archive. The image files of Turbo Seek are located in the 'html' directory inside the .zip archive.

Step 4 - Re-register Turbo Seek

When you purchased Turbo Seek you received an email with a serial detailing the registration of Turbo Seek. Follow these instructions again to register Turbo Seek.

Step 5 - If you would like to enable image authentication do the following steps (recommended)

Image authentication lets your visitors type letters displayed when making a new submission or when submitting reviews/comments for links. Image authentication makes it impossible for automated scripts to submit spam submissions to the Search Engine & Directory.

To enable Image authentication, login to the Turbo Seek ver 2.x control panel. After that click the 'Settings' tab and then click on 'Global Engine Settings'. Now look for the following settings:

  • Enable Image Authentication when visitors submit links?

  • Enable Image Authentication when visitors post comments/reviews?

Set both these settings to 'Yes'.

After doing the above click the 'Template Manger' tab from the Turbo Seek Control Panel.

Now edit the following templates:

  • Add URL

  • Review Display

Between the <form> tags of the templates mentioned above add the following HTML code:

%%imgbox%%<br>
Please type the letters listed above:<br>
<input type="text" name="letters" size="22">

After you have added the above HTML code to the templates, visitors will be required to supply letters matching letters displayed on the submissions and review/comments forms. This ensures that automated scripts cannot submit Spam submissions to the Search Engine & Directory.

 

1.5 Uninstallation

Why Turbo Seek comes with an uninstaller?

The uninstaller will remove files that has been created by the web server with Turbo Seek. The reason this uninstaller exists is because the web server creates and writes files with a different user or UID/GID than the user or UID/GID that sets up the scripts.

Difficult uninstallations of cgi scripts is common, because of the problem explained above. Once files has been created by cgi scripts nobody except the 'Root' account or the 'cgi scripts' itself can remove files created by the cgi scripts - This is the case with a lot of Unix cgi script installations.

To remove Turbo Seek from your server/hosting account, execute admin10.cgi and follow the instructions.

Note that all links, data and settings that you entered into Turbo Seek will be lost after this uninstall.

After you ran the uninstaller, remove the .cgi files and the rest of the files that you transferred when doing the installation.

 

1.6 How to create your search engine in just a few steps (Tutorial & Overview)

Lets say you have now successfully installed Turbo Seek and you want to start creating your search engine and directory.

The promise of Turbo Seek is to enable you to create, run and manage your directory with ease and be fully customizable at the same time. Every effort has been made to make the use of it as is easy as possible, and in most cases instructions and help notes are to be found all over the control panel.

In order to get you started straight away and to give you a good idea how everything works together, please read this tutorial. This tutorial will save you time and you will see how easy it is to use Turbo Seek.

1.6.1 (Step 1) Create Your Directory Structure

Create your directory structure. Your directory structure is the directories you would like to place links in. You can create your directory structure by going to the Admin Control Panel and then by clicking the 'Directory Manager' tab. Once you are in the Directory Manager, add Directories and Links. Experiment, by adding Directories and Links, moving links, or whatever you please.

1.6.2 (Step 2) Add Links To Your Directories

Let's say you now have the directory structure you want to use. Now you will need to add links to these directories. Just click on any directory in the 'directory manager' and click the 'add listing' button.

If you want to add your own extra fields/keys for your link listings see 'Adding your own fields/keys' on how to do this. (You can also add extra fields/keys at any time) Extra/fields keys allows you to add extra information to links, like pricing, addresses, extra descriptions, etc. You can also collect these extra details from visitors who submit links.

1.6.3 (Step 3) Creating The Front Page of Your Search Engine & Directory

First choose what kind of Directory you will run. You can run two kinds of Directories. You can run a 'Live' Directory or a 'Static' Directory.

  • What is a live directory? (Live)
    The link listings and pages displayed in your Directory is created on the fly via Turbo Seek's cgi scripts. This means that you won't have static HTML files that visitors will load when browsing your Directory but only CGI scripts.

  • What is an HTML generated directory? (Static)
    Turbo Seek will generate HTML files of your entire Directory structure. Note that you have to generate the HTML files first before these links will work. To generate the .html files click on the 'Build Indexes' button and then 'Build Directory Index'. It is recommended that you run a static directory, due to performance reasons. Another reason why we recommend this is because your category/directory pages are static pages where the URLs of these pages are Search Engine friendly. This means that the Crawlers and Spiders (advanced or basic crawlers/spiders) of Search Engines will index your directory/category link pages, as there are no complicated CGI script URLs involved

To configure Turbo Seek to run a 'Live' or 'Static' Directory, go to the Control Panel >> Settings >> Global Engine Setting >> Look for a setting that reads: 'Would you like to run a static or dynamic Directory?'

Now go to the Control Panel >> Template Manger >> Create/Edit Front Page

Choose a method to create your Front Page.

The next screen will ask you to configure how categories will be displayed on your Front Page.

After configuring how categories will be displayed the next screen will provide you with HTML code or JavaScript code or instructions on what to do.

Below are some notes/instructions for the Front Page creation methods:

  • JavaScript - You create a web page (index.html for example) that contains everything you want your Front Page to contain. (Logo's, graphics, texts, etc). You then get the JavaScript code and Search Box HTML code and place it inside this web page to display your categories and search box. After that you upload the web page you created and use it as your Front Page or Index page of your Directory.  

  • Manual Front Page Creation - Here you just obtain the links to main categories and place them inside a web page (index.html for example). You then upload the web page and use it as your Front Page. Note that category names/links won't automatically update when you make changes to the main categories.  

  • Write Categories to an existing Front Page (index.html) for example - With this method of Front Page creation you create a web page (index.html for example) and place your logo's, texts, graphics, etc. and everything you want to display on this Front Page. Turbo Seek then writes categories (your main categories) to this file.  

  • Server Side Includes - You create a web page (index.html for example) that contains everything you want your Front Page to contain. (Logo's, graphics, texts, etc). You then place SSI include code and the Search Box HTML code inside this web page to display your categories and search box. After that you upload the web page you created and use it as your Front Page or Index page of your Directory.

1.6.4 Adding Search Capability to your Search Engine and Directory

By now you should have created directories, added links and your front page should be ready. In order to enable users to search with your search engine and directory you will need to build a search index. To build the search index, just click the 'Build Indexes' tab and then click on 'Build Search Index'. After the search index is built load up your front page and do a search. Please note that if you add/remove/edit links or directories you will have to rebuild the search index to reflect the changes.

Why do I have to build a search index?
A search index packs data in a database file especially for searching purposes. This speeds up searching and uses less resources on your host/server.

1.6.5 Notes On Running a HTML Generated Directory

If you decide to run an HTML generated Directory you will need to generate the HTML files. This can be done by clicking on the 'Build Indexes' button in the control panel and then on 'Build Directory Index'.

1.6.6 Final Notes on This Tutorial

This tutorial covers the basics of getting your Search Engine and Directory going. The rest of the Turbo Seek documentation will explain the more advanced features and the rest of the features in detail. Turbo Seek is loaded with many other vital and useful features. The easiest way to get to know Turbo Seek is to experiment. Play around with it, consider it as your new toy.
      

<< Previous Page
Index

Index

Next Page >>

ffbotl.gif (1447 bytes)
Site Map | PowerSeek | Turbo Seek | HTML Rotate | Quick Polls | FM SiteSearch Pro | Download Monitor | SiteNet BBS | More...
Products | Support Desk | Affiliate Program | Web Hosting | FocalMedia.Net Featured On | Contact us
ffbotr.gif (1456 bytes)