Index
1) Introduction
2) Installation instructions
- System Requirements
- Installation
- Support
3) Administration Interface
- First Login
- Fields and buttons
4) Searching
- Search Boolean logic
5) Layout
- Templatevariables
6) Urgent infos
- costs
- updates
7) License
1) Introduction
With phpMySearch you can realise a searchengine for your or custom homepages.
phpMySearch is not meant to replace a powerful internet-wide search systems
how Google, Lycos or AltaVista.
Queries like in big searchengines are possible: download +software or
download OR software
phpMySearch is provided by the most InternetServiceProvider (ISP) and has
a very easy installation.
For the installation you did not need programmer- or webserverknowledge. The
complete installation needs about 3-5 minutes and you will need a little
texteditor and a FTP-programm. The configuration can be changed at any time
and comfortably with a Browser (e.g. Netscape).
The adjustment to your own homepagedesign is very simply, because the complete
layout of phpMySearch is realized with templates. So you can modify the
templates with a simple HTML editor to make an individually layout.
Documents can be searched in the html, pdf or txt format. Outdated documents
are detected automatically and deleted from the data base. Thus one ensures,
which only the most current information is displayed to your visitors.
phpMySearch runs already reliably on different Linux, UNIX, as well as
on Windows operating systems and supports all usual protocolls how: http, https,
ftp, ftps. The employment can take place in the InterNet as well as in the Intranet.
We offer also our forum to you, where you can exchange yourselves with
other users of phpMySearch, if it concerns e.g. questions or assistance.
phpMySearch may be used privately as well as commercially, free of charge
and without restrictions, as long as the copyright notice on phpMySearch at
the end the search output is preserved. Support licenses help to be able to
support you around you with larger and more complex projects in the best way.
[go to top]
2) Installation instructions
System Requirements
· All operating systems, which supports the following:
· MySQL 3.23.32 or higher (http://www.mysql.com)
· PHP 4.0.2 or higher (http://www.php.net)
· CURL 7.0.2 or higher (http://curl.haxx.se)
Installation:
1. Download phpMySearch from http://phpmysearch.web4.hm to your system.
For *nix-systems download the phpMySearch.tar.gz file, for windows*-systems download the phpMySearch.exe file.
2. a) Windows: Double click on the phpMySearch.exe and follow the instructions.
b) Unix: Extract phpMySearch under a unixshell with:
tar -xzf phpMySearch.tar.gz
3. Copy all files from the new generated folder phpMySearch to a folder from your webspace which is accessable from web (e.g. http://www.example.com/phpMySearch/ )
After that execute with a browser the install.php (e.g. http://www.example.com/phpMySearch/install.php)
4. Setup phpMySearch with admin.php from a browser window.
Support
You can get commercial support lincenses at http://phpMySearch.web4.hm.
[go to top]
3) Administration Interface
To access administrative interface run the admin.php with a browser.
Default login and password are:
login: admin
password: admin
RECOMMEND TO CHANGE
|
Field or button |
Description |
|
Search start URL's: |
A list of URLs from which crawler will start to gather information. To add new URL to the list type it in the field below and push ADD button. To remove any of the URLs check the checkboxes near URLs you´d like to delete and push REMOVE button. e.g.: |
| Numer of attempts to retrieve the page: | If a document or server is not availible phpMySearch will try to connect to it x times. |
|
Not indexed URL's (Black list) |
List of URLs, which will be ignored by crawler. . To add new URL to the list type it in the field below and push ADD button. To remove any of the URLs check the checkboxes near URLs you´d like to delete and push REMOVE button. |
|
Document extensions to index |
A list of document extensions which spider should try to index. To add new document extension to the list type it in the field below and push ADD button. To remove any of the extensions check the checkboxes near extensions you´d like to delete and push REMOVE button. |
|
Search depth |
Search depth tells spider how much iteration he should follow links from the pages and proceed with crawling. |
|
Reparse all |
If check box is checked spider will clean database and start to ramble, otherwise it will parse only pages that were updated. By default it is unchecked |
|
Automatic spider start |
Check this box if you have not access to crontab tool at *nix systems or task scheduler in Windows system. If it is checked each time visitor use search script, it will check whether it is time to start the crawler. If it founds that it is time to start the time or crawler was not started at specified time script will start the spider script. |
|
Start time |
Time to start the spider |
|
Start spider each (days) |
Period in days to restart the spider (in days) |
|
Force crawling |
Click on Start Spider button to start spider immediately |
|
Number of links per page |
Specify here number of links, which should be displayed on a single page. |
|
Max pages block |
Specify how many pages should be visible in pages menu |
|
Proxy settings active |
Check this box if you want that the spider shell connect to proxy. Please note that this function in BETA and for testing. If you have any problems with proxysupport, we´ll be glad for any response. |
|
Proxy host |
Fill in here the proxy host. (e.g. an ip 192.168.0.1 or a host). If you must use a special port you can type host:port |
|
Proxy user and pass |
Fill in here if you need a user and password for the proxy. Please fill in in the following format: User:Password |
|
Search Engine log file name |
Enter path to the file where search engine will log its work. |
|
Spider Engine log file name |
Enter path to the file where spider will log its work |
|
Admin Tool log file name |
Enter path to the file where will be logged all changes in admin tool |
|
Templates path |
Path to template files |
| PHP FullPath: | Fill in here the path to php. You can fill in php, sometime you must type in the fullpath to php e.g. php, /usr/bin/local/php or c:\php\php.exe. At windows platforms you can use backslash "\" or frontslash "/". |
| Converter URLs: |
Filetypes how PDF, DOC and XLS must phpMySearch transform into HTML-format. |
|
Admin Login |
Login name of administrator |
|
Admin Password |
Administrators password |
|
Confirm Password |
Confirmation of administrators password |
|
Submit |
By clicking on Submit button you all save all changes |
|
Logout |
By clicking on Logout button you logout from the admintool |
[go to top]
4) Searching
If you want to search for a single word it is simple. Just execute the search.php in your browser. Now type the word you'd like to search for in the textfield and press Submit.
You also can use Boolean logic to narrow search. See table below for operators allowed.
Table 2-1:Search Boolean logic.|
Operator |
Description |
|
AND |
Finds documents containing all of the specified words or phrases. Peanut AND butter finds documents with both the word peanut and the word butter. |
|
OR |
Finds documents containing at least one of the specified words or phrases. Peanut OR butter finds documents containing either peanut or butter. The found documents could contain both items, but not necessarily. |
|
AND NOT |
Excludes documents containing the specified word or phrase. Peanut AND NOT butter finds documents with peanut but not containing butter. NOT must be used with another operator, like AND. Search engine does not accept 'peanut NOT butter'; instead, specify peanut AND NOT butter. |
|
OR NOT |
Finds documents containing one of the specified words or phrases or not containing other word. Peanut OR NOT butter finds documents which contain Peanut or not containing butter |
|
“” |
Quotation marks are used to denote exact phrases. For example, a search on "New York Times" will match only documents containing the words as an exact phrase. It will not find pages with the words used in a different order, such as "New times in York!" |
|
{ } |
Braces are used to denote folders. For example, a search on "CPAN/objects" will match only documents stored in www.servername.com/currentlocation/CPAN/objects |
You also can navigate through the site folder structure. In the dropdown box before Submit button you will see list of subfolders of the current folder. By selecting the folder name you localize search to this folder and its subfolders. '..' allows you to go one step up.
[go to top]
5) Layout
You can make your own design by using the templates and a wysiwyg Editor [eg. Dreamweaver].
You find the templates in the folder "templates" in your phpMyAdmin Directory, or when you change it in the adminpanel, then in the "TemplatesPath" directory.
All templates with the "adm" prefix are for the admintool.
All others [eg. main.tpl,body.tpl,body_docfrom.tpl,body_ok.tpl,refs.tpl.] are the seachengine templates.
Here you see an overwiew how the single templates are:
Here is a short list, which variables you can use. It's important that you work case sensitive and that all variables in the templates stand in braces [eg. {VARIABLE} ]. This is very important, all others wan't work!
|
Templatevariables |
Description |
|
{QUERY} |
Search String |
|
{PAGES} |
Search Result |
|
{ERROR} |
Error Message |
|
{OUT_CURR_PATH} |
Searchpath |
|
|
|
|
{URL} |
Result URL |
|
{pageDate}
|
Result Date |
|
{expiresDate}
|
Expires Date |
|
{title}
|
Webside Title |
|
{description}
|
Description (META-Tag) |
|
{keywords}
|
META-TAG: keywords |
|
{author}
|
META-TAG: Author |
|
{replyTo}
|
META-TAG: replyTo |
|
{publisher}
|
META-TAG: Publisher |
|
{copyright}
|
META-TAG: copyright |
|
{contentLanguage}
|
META-TAG: language |
|
{pageTopic}
|
META-TAG: page Topic |
|
{pageType}
|
META-TAG: page type |
|
{abstract}
|
META-TAG: abstract |
|
{classification}
|
META-TAG: classification |
|
{body_1}
|
META-TAG: text from the website (first 255 chars) |
|
{body_2}
|
META-TAG: text from the website (all others) |
When you change the drop down menues to checkboxes, radiobuttons or hidden fields, so look at the variables names, the names must be the same as in the default templates.
The search.php needs some variables to work [eg. page,currPath] you can set this with hiddenfields, too. The form action is always GET. If you have problems, have a look in the default templates.
In our case
You can send us your template or your link to your search and perhaps we will put it to the offical templates in the next version of phpMySearch.
[go to top]
6) Urgent infos
main
Please note if phpMySearch visits Websites and store into your database, that you need the agreement from the websiteowner, that you are allowed to do this.
costs
If the phpMySearch-Spider visitswebsites, which are not local on the same webserver, that you get much datatransfer between both servers. From this reason, it can be, that you get much costs.
updates
You can subscribe the newsletterservice at http://phpMySearch.web4.hm and we will inform you automaticly from updates.
Also, you can find everytime updates at this homepage.
[go to top]
7) License
---------------------------------------------------------------------
The phpMySearch License, version 5.0
Copyright (c) 2001 - 2002 The phpMySearch Group. All rights reserved.
---------------------------------------------------------------------
Redistribution and use in source and binary forms, with or without
modification, is permitted provided that the following conditions
are met:
1. You may use this software and documentation for free, privately as well as commercially,
free of charge and without restrictions, so long this license and the copyright notice,
in the software and documentation and at the end of the search output is preserved.
2. You are allowed to modify the sourcecode, when you mail us the changed sourcecode
to phpMySearch@web4.hm
3. The name "phpMySearch" must not be used to endorse or promote products
derived from this software without prior permission from the
phpMySearch Group. This does not apply to add-on libraries or tools
that work in conjunction with phpMySearch.
4. The phpMySearch Group may publish revised and/or new versions of the
license from time to time. Each version will be given a distinguishing version number.
Once covered code has been published under a particular version of the license,
you may always continue to use it under the terms of that version.
You may also choose to use such covered code under the terms of any subsequent version of the license
published by the phpMySearch Group.
No one other than the phpMySearch Group has the right to modify the terms
applicable to covered code created under this License.
5. This product is not free for reselling - reselling free code parts
from phpMySearch needs a special product-registration from the phpMySearch Group.
6. The phpMySearch Group is allowed to forbid the usage of this program or code-parts.
7. THIS SOFTWARE IS PROVIDED BY THE PHPMYSEARCH DEVELOPMENT TEAM 'AS IS' AND
ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PHPMYSEARCH
DEVELOPMENT TEAM OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
--------------------------------------------------------------------
For more information on the phpMySearch Group and the phpMySearch project,
please see http://phpMySearch.web4.hm.
phpMySearch is a project from:
Webagentur web4.hm
Pyrmonter Strasse 42
D-31789 Hameln, Germany.
Tel: +49-5151-609970-0
http://www.web4.hm
phpMySearch@web4.hm
[go to top]
