
 CNSearch - Simple to Install and Maintain Search System for Web-sites.
                
                E-mail:support@cn-software.com
                http://cn-software.com


 
 Contents of this file:
 
 I. BRIEF OVERVIEW.
 II. INSTALLATION.
 - downloading;
 - Windows installation;
 - UNIX installation;
 - IMPORTANT NOTES
 III. SUPPORT.
 
 I. BRIEF OVERVIEW.
 
 CNSearch is a search system that works under Windows, UNIX, and
 Linux servers.

 CNSearch is a very convenient solution for those, who runs their 
 web-sites on third-party hosting systems.
 
 The system is composed of two parts - an Indexer and a Frontend. The
 Indexer performs analysis of one or more web-sites according
 to the settings you make. You may select file types to be indexed,
 set index templatesand rules, etc. There are plug-ins included in this
 distribution which may be used for precise analysis of .doc, .rtf, and
 .txt files. The Frontend performs a search in the created index file.
 Special features of the system are possibility of installation of the
 Indexer and Frontend on different computers and fast search in the 
 index file.
 
 Latest versions are available at http://cn-software.com/
 
 II. INSTALLATION
 
 a) CNSoftware distributes CNSearch as one .zip file which includes
 versions for various Operating Systems

The following OS are supported:
 
 Windows 95/98/Me/NT/2000/XP
 Linux 2.0.4
 FreeBSD 3.X
 FreeBSD 4.X
 Solaris 7/8 (Sparc)

 
 Please, contact your hosting provider, if you do not know which OS your
 web-server is running on.
 
 NOTE: since the two parts (Frontend and Indexer) of CNSearch can work
 independedly on different computers, you may select necessary versions 
 and run them on different operating systems. See below for details.
 
 b) WINDOWS INSTALLATION.
 
 1) - unpack downloaded zip-archive with pkunzip supporting long file
 names (pkzip25 or WinZIP). More information about archivers may be
 found at http://www.pkware.com/ :
 
	pkzip25 -extract -dir cnsearch.zip
 
 2) - go to 'cnsearch-VERSION' directory, where you'll find 
 three directories and two files 'readme.txt', 'License.txt', and
 'index_example.htm':

  manual            - contains manual pages
  unix              - contains UNIX versions
  windows           - contains Windows version
  index_example.htm - example HTML file containing search form code
  License.txt       - license notes
  readme.txt        - this file


 
 3) - go to 'windows/indexer' directory and run 'searchctl.exe' with
 necessary params (see section 'Setting Up the Indexer' of the manual
 for details).

 For example:
 
        searchctl.exe localhost
 
 will build index files of your local web-server documents.
 You will also get some new files: 
 
        docs.cns
        files.cns
        index.cns
        stats.log
 
 Copy them to 'cgi-bin' directory of your web-site and make sure you
 set read/write permissions for them. The server must be able to change
 these files.
 
 4) - go to 'windows/frontend' directory and copy two files 'search.exe'
 and 'search.htm' to 'cgi-bin' directory of your web-site.
 
 5) Now, you may check how it is working. Start your browser and 
 (assuming that we are searching at localhost) enter
 http://localhost/cgi-bin/search?q=document
 
 You should see a page with search results. See manual for details how
 include search forms in pages and organize templates.

 6) You may use 'index_example.htm' file found in 'cnsearch-VERSION'
 directory to insert a search form into your web-pages and experiment 
 with its settings.
 
 c) UNIX INSTALLATION

 1) - unpack downloaded zip-archive with pkunzip supporting long file
 names (pkzip25 or WinZIP). More information about archivers may be
 found at http://www.pkware.com/ :
 
	pkzip25 -extract -dir cnsearch.zip
 
 2) - go to 'cnsearch-VERSION' directory, where you'll find 
 three directories and two files 'readme.txt', 'License.txt', and
 'index_example.htm':

  manual            - contains manual pages
  unix              - contains UNIX versions
  windows           - contains Windows version
  index_example.htm - example HTML file containing search form code
  License.txt       - license notes
  readme.txt        - this file


 
 3) - go to 'unix' directory and select an appropriate version.

 Linux 2.0.4          linux.tar.gz    
 FreeBSD 3.X          freebsd3.tar.gz 
 FreeBSD 4.X          freebsd4.tar.gz 
 Solaris 7/8 (Sparc)  solaris8.tar.gz  
 

 4) Unpack selected gzip-archive (.tar.gz), for example for FreeBSD 4.X:
 	
        tar -czf freebsd4.tar.gz
    or
        gunzip freebsd4.tar.gz
        tar -cf freebsd4.tar
 
 
 5) - go to './freebsd4' (for example) directory, where you'll find two
 sub-directories:
 
   frontend          - contains the Frontend
   indexer           - contains the Indexer
   
 
 6) Now, you have to build indexes with the Indexer which
 is stored in 'indexer' directory. Go to 'indexer' directory
 and run 'searchctl' with necessary params (see section 'Setting
 Up the Indexer' of the manual for details).
 
 For example:
 
 	./searchctl localhost
 
 will build index files of your local web-server documents.
 You will also get some new files: 
 
        docs.cns
        files.cns
        index.cns
        stats.log
 
 Copy them to 'cgi-bin' directory of your web-site and make sure you
 set read/write permissions for them. The server must be able to change
 these files.
 
 7) - go to 'frontend' directory and copy two files 'search' and
 'search.htm' to 'cgi-bin' directory of your web-site. Don't forget
 to check out for permission for the web-server to run 'search' and read
 'search.htm'
 
 5) Now, you may check how it is working. Start your browser and
 (assuming that we are searching at localhost)
 enter http://localhost/cgi-bin/search?q=document
 
 You should see a page with search results. See manual for details
 how include search forms in pages and organize templates.
 
 6) You may use 'index_example.htm' file found in 'cnsearch-VERSION'
 directory to insert a search form into your web-pages and experiment 
 with its settings.

 
 IMPORTANT NOTES:

 NOTE 1.

 If your server uses third party hosting, all you need for installation
 is access to 'cgi-bin'.
 
 NOTE 2.

 You  can  also  run the Indexer on Windows machine and the Frontend
 on UNIX and  vice  versa. For example, you have only ftp-access
 to 'cgi-bin' directory at your hosting-provider and your home computer
 runs under MS Windows. 

 On your home computer install the Indexer and perform indexing of your
 web-site. When you finish, you need to copy the Frontend and files 
 created by the Indexer (docs.cns, files.cns, index.cns, stats.log) to 
 your hosting-provider's 'cgi-bin' directory. ATTENTION! Do not forget 
 to set write permissions for these files.


 III. SUPPROT.

 Technical support is available at  http://cn-software.com or via 
 e-mail: support@cn-software.com
