| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" |
| 2 |
"http://www.w3.org/TR/REC-html40/strict.dtd"> |
| 3 |
<!-- http://computers.douglasthrift.net/searchengine/README.html --> |
| 4 |
<html> |
| 5 |
<head> |
| 6 |
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" |
| 7 |
> |
| 8 |
<title>Douglas Thrift's Search Engine ReadMe</title> |
| 9 |
<style type="text/css"> |
| 10 |
<!-- |
| 11 |
H1 { font: bold small Tahoma, sans-serif; text-align: left; |
| 12 |
margin-bottom: 0.6em; margin-top: 0em |
| 13 |
} |
| 14 |
P { font: normal small Tahoma, sans-serif; text-align: left; |
| 15 |
margin-bottom: 0.6em; margin-top: 0em |
| 16 |
} |
| 17 |
P.indent { margin-left: 1.8em } |
| 18 |
UL { margin-bottom: 0em; margin-top: 0em } |
| 19 |
LI { font: normal small Tahoma, sans-serif; text-align: left } |
| 20 |
--> |
| 21 |
</style> |
| 22 |
</head> |
| 23 |
<body> |
| 24 |
<h1>Douglas Thrift's Search Engine ReadMe</h1> |
| 25 |
|
| 26 |
<h1>Copyright © 2002, Douglas Thrift. All Rights Reserved.</h1> |
| 27 |
|
| 28 |
<h1><img src="osi-certified-90x75.png" |
| 29 |
alt="OSI Certified Open Source Software" |
| 30 |
title="OSI Certified Open Source Software"></h1> |
| 31 |
|
| 32 |
<p>Douglas Thrift's Search Engine is an indexing search engine for use |
| 33 |
on small websites such as personal or small business sites. It is |
| 34 |
designed to be very similar to Google for end users and its output |
| 35 |
is customizable. For indexing, it supports both the Robots |
| 36 |
Exclusion Protocol and the Robots META Tag as specified at <a |
| 37 |
href="http://www.robotstxt.org/wc/exclusion.html" |
| 38 |
>http://www.robotstxt.org/wc/exclusion.html</a>.</p> |
| 39 |
|
| 40 |
<h1>System Requirements</h1> |
| 41 |
|
| 42 |
<p>To run Douglas Thrift's Search Engine on Windows you need:</p> |
| 43 |
|
| 44 |
<ul> |
| 45 |
<li><p>Windows 95/98/ME or Windows NT 4/2000/XP</p></li> |
| 46 |
<li><p>Perl 5.6 or higher (available at <a |
| 47 |
href="http://www.activestate.com/Products/ActivePerl/" |
| 48 |
>http://www.activestate.com/Products/ActivePerl/</a>)</p></li> |
| 49 |
<li><p>Java 1.4 or higher (available at <a |
| 50 |
href="http://java.sun.com/j2se/1.4/download.html" |
| 51 |
>http://java.sun.com/j2se/1.4/download.html</a>)</p></li> |
| 52 |
</ul> |
| 53 |
|
| 54 |
<p>Of course, it would also be a good idea to have an HTTP Server that |
| 55 |
supports CGI, such as IIS or Apache (available at <a |
| 56 |
href="http://httpd.apache.org/">http://httpd.apache.org/</a>).</p> |
| 57 |
|
| 58 |
<p>At the time of writing, Douglas Thrift's Search Engine is only |
| 59 |
available for the Windows platform. I will be working to port it to |
| 60 |
Linux and FreeBSD, but if you are brave you could try porting it to |
| 61 |
your platform from the Windows source code distribution.</p> |
| 62 |
|
| 63 |
<h1>Installation</h1> |
| 64 |
|
| 65 |
<p>After running the Windows Installer some environment variables need |
| 66 |
to be set:</p> |
| 67 |
|
| 68 |
<ul> |
| 69 |
<li><p><em>JAVA_HOME</em> should be set to your Java Runtime |
| 70 |
Environment directory (usually <em>C:\Program |
| 71 |
Files\Java\j2re1.4.0</em> or similar).</p></li> |
| 72 |
<li><p><em>PATH</em> should include <em |
| 73 |
>%JAVA_HOME%\bin;%JAVA_HOME%\bin\client</em>.</p></li> |
| 74 |
</ul> |
| 75 |
|
| 76 |
<p>To run Douglas Thrift's Search Engine with your HTTP Server you will |
| 77 |
need to copy <em>search.cgi</em> to either your Server's <em |
| 78 |
>cgi-bin</em> directory or somewhere else where CGI programs can be |
| 79 |
executed. You may also need to change the copied file's extension |
| 80 |
to <em>.pl</em>, and you may need to edit its contents to suit your |
| 81 |
configuration.</p> |
| 82 |
|
| 83 |
<p>When you are ready to start running the program open a Command |
| 84 |
Prompt and change to the directory where it is installed and run |
| 85 |
<em>Search.exe</em>, it will display a list of the options you |
| 86 |
need. The <em>search.cgi</em> script uses any <em>.xml</em> files |
| 87 |
in <em>C:\Program Files\Douglas Thrift's Search Engine</em> by |
| 88 |
default; you may change this by editing it.</p> |
| 89 |
|
| 90 |
<h1>Compilation</h1> |
| 91 |
|
| 92 |
<p>To build Douglas Thrift's Search Engine from the source code you |
| 93 |
will need:</p> |
| 94 |
|
| 95 |
<ul> |
| 96 |
<li><p>Either Microsoft Visual C++ 6.0, the Microsoft Platform SDK, |
| 97 |
or another C++ development environment with a make |
| 98 |
utility</p></li> |
| 99 |
<li><p>Java SDK 1.4 or higher (available at <a |
| 100 |
href="http://java.sun.com/j2se/1.4/download.html" |
| 101 |
>http://java.sun.com/j2se/1.4/download.html</a>)</p></li> |
| 102 |
</ul> |
| 103 |
|
| 104 |
<p>Before you try to build it some environment variables need to be |
| 105 |
set:</p> |
| 106 |
|
| 107 |
<ul> |
| 108 |
<li><p><em>JAVA_HOME</em> must be set to your Java Development Kit |
| 109 |
directory (usually <em>C:\j2sdk1.4.0</em> or similar)</p></li> |
| 110 |
<li><p><em>PATH</em> should include <em |
| 111 |
>%JAVA_HOME%\jre\bin;%JAVA_HOME%\jre\bin\client</em>.</p></li> |
| 112 |
</ul> |
| 113 |
|
| 114 |
<p>To build from the source code you need to unzip the distribution |
| 115 |
file, open a Command Prompt, and change to the <em>dtsearch</em> |
| 116 |
directory where you unzipped. Then run your make utility (<em |
| 117 |
>NMAKE</em>), and if there were no errors run the make utility |
| 118 |
again with install as its argument (<em>NMAKE install</em>).</p> |
| 119 |
</body> |
| 120 |
</html> |
