home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / mnog3119.zip / INSTALL < prev    next >
Text File  |  2001-06-08  |  8KB  |  280 lines
  1. mnoGoSearch Installation notes
  2. ==============================
  3.  
  4. Requirements
  5. ============
  6.  
  7. SQL database requirements
  8. -------------------------
  9. Note that if you want to compile mnoGoSearch with one of supported
  10. SQL database you must have database already installed before 
  11. installing mnoGoSearch.
  12.  
  13. You also should have enough permissions to create new database
  14. or to write into already existing one.
  15.  
  16. MySQL notes:
  17. We tested mnoGoSearch with 3.22.x, 3.23.x MySQL version, 3.21.xx will not
  18. work with mnoGoSearch.
  19.  
  20. PostgreSQL notes:
  21. If you want to build mnoGoSearch with PostgreSQL, more than 6.5.x release
  22. required, which have LIMIT SQL clause. Note that Pg-6.5.3 crashes in "crc" 
  23. and "crc-multi" mode.
  24.  
  25. iODBC notes:
  26. iodbc-2.50.22a is known to work
  27.  
  28. unixODBC notes:
  29. unixODBC-1.7 is known to work
  30.  
  31. Solid notes:
  32. 03.00.0043 version is known to work
  33.  
  34. InterBase notes:
  35. 4.0 version had been tested
  36.  
  37. Oracle8 notes:
  38. 8.0.5.X is known to work
  39.  
  40. Oracle8i notes:
  41. 8.1.6 R2 EE is known to work
  42.  
  43.  
  44. Supported operating systems
  45. ===========================
  46.  
  47. We use GNU Autoconf so it is possible to compile and use mnoGoSearch on
  48. almost every modern UNIX system with a C compiler without any modifications.
  49. We develop the software on FreeBSD 3.x and Linux 2.2
  50.  
  51. Currently known systems mnoGoSearch has been successfully compiled and tested on 
  52. are:
  53.  
  54.     * FreeBSD 2.2.5
  55.     * FreeBSD 3.x
  56.     * FreeBSD 4.x
  57.     * Linux 2.x
  58.     * sun4u sparc SunOS 5.6
  59.     * Solaris7 x86
  60.     * BSDI 4.1
  61.     * OpenBSD 2.5
  62.     * HP-UX B.10.20 ( GNU "sed" required)
  63.     * Digital Unix V4.0 (aka Compaq Tru64 UNIX)
  64.     * SCO UnixWare 7.x
  65.     * AIX 4.2
  66.     * SGI Irix 6.5
  67.     * YellowDog Linux for PPC on Mac G3
  68.     * MacOSX 10.0.0
  69.  
  70. We hope mnoGoSearch will work on other Unix platforms as well. 
  71. Please report successful platforms to devel@mnogosearch.org
  72.  
  73. Tools required for installation
  74. ===============================
  75.  
  76. You need the following tools to build and install mnoGoSearch from source:
  77.  
  78.    * GNU gunzip to uncompress the distribution.
  79.  
  80.    * A reasonable tar to unpack the distribution. GNU tar is known
  81.      to work.
  82.  
  83.    * A working ANSI C compiler. GNU gcc is known to work.
  84.  
  85.    * A good make program. GNU make is always recommended and
  86.      sometimes required.
  87.  
  88. Installing mnoGoSearch
  89. ======================
  90.  
  91. 1. Unpack the distribution and change dir into the top-level directory 
  92. of the unpacked distribution.
  93.  
  94.     tar -zxf mnogosearch-x.x.x.tar.gz
  95.  
  96. 2. To simplify configuration process we included a configuration script with the package - install.pl
  97. Run install.pl and select mnoGoSearch configuration options in a question-and-answer manner. After you 
  98. specify all the configuration options, the script will run ./configure with the options you chose. It 
  99. will also create install.options file containing your configuration preferences that you can use to run 
  100. the script later bypassing questions. After configuration is finished, build and install the package as 
  101. described in section 3.
  102.  
  103.  
  104. 2a. In case you would like to configure mnoGoSearch manually without using the configuration script, 
  105. do the following:
  106.  
  107. Configure the package with built-in database support
  108.  
  109.     sh$ ./configure --with-built-in
  110.  
  111.  
  112. 2b. Configure the package with SQL database support
  113.  
  114.     sh$ ./configure --with-mysql
  115. or
  116.     sh$ ./configure --with-pgsql
  117. or
  118.     sh$ ./configure --with-msql
  119.  
  120. or with enother depending on what database you prefer.
  121.  
  122. By default, mnoGoSearch is installed in '/usr/local/mnogosearch'
  123. in the following subdirectories:
  124.  
  125. Directory        Contents
  126.  
  127. bin             search.cgi
  128. lib             libudmsearch.a(so)
  129. sbin            indexer
  130. etc             indexer.conf-dist, search.htm-dist
  131. man             indexer.1, indexer.conf.5
  132. doc        Various documentation
  133.  
  134. If you have no permissions to write to that directory or just want to install
  135. mnoGoSearch to another location, please use configure with --prefix option, e.g.
  136.  
  137.     ./configure --prefix=/user/home/mnogo --with-built-in 
  138.  
  139. or with mysql database support:    
  140.     
  141.     ./configure --prefix=/user/home/mnogo --with-mysql    
  142.  
  143.  
  144. To install mnoGoSearch with HTTPS support, use configure with the following option:
  145.  
  146.     ./configure --with-openssl
  147.     
  148. or in case the OpenSSL library is installed in a non-standard location:
  149.     
  150.     ./configure --with-openssl=/path/to/library
  151.     
  152. Please note that you need OpenSSL library installed on your system.
  153.  
  154. You can see all available options with ./configure --help
  155.  
  156. It you want to provide some specific flags to C compiler (for example,
  157. '-O7 -mpentium' to build highly optimized binary for Pentium processor
  158. if you use egcs/pgcc), you can do so using command
  159.  
  160.     sh$  CFLAGS="-O7 -mpentium"
  161.     
  162. _before_ running configure.
  163.  
  164. To compile mnoGoSearch on FreeBSD with Solid in old aout format,
  165. use
  166.  
  167.     sh$ CFLAGS="-aout"
  168.  
  169. before running configure.
  170.  
  171. To compile mnoGoSearch on FreeBSD with aout InterBase, use
  172.  
  173.     sh$ CFLAGS="-aout -static"
  174.  
  175. before running configure.
  176.  
  177. You may also specify --enable-freebsd-pthreads or --enable-linux-pthreads
  178. to compile multi-threaded indexer on FreeBSD and Linux machines.
  179.  
  180. To enamble DMALLOC memory debugger support use --enable-dmalloc. 
  181.  
  182. If you run into problems with configure, please see section
  183. 'Installation problems'.
  184.  
  185. 3. Build and install the package.
  186.  
  187.     sh$ make
  188.     sh$ make install
  189.  
  190. If you run into problems while doing make, please see section
  191. 'Installation problems'
  192.  
  193. 4. Create database 'mnogosearch' ( for SQL database only )
  194.  
  195. You can also use existing database, skip this step in this case.
  196.  
  197. MySQL:
  198.     sh$ mysqladmin create mnoGoSearch
  199.  
  200. PostgreSQL:
  201.     sh$ createdb mnogosearch
  202.  
  203. miniSQL:
  204.     sh$ msqladmin create mnogosearch
  205.  
  206. Use database specific documentation for other databases.
  207.  
  208.  
  209. 5. Create tables ( for SQL database only )
  210.  
  211. Change dir to 'create/your_database' directory of the distribution 
  212. and create tables structure.
  213.  
  214. MySQL:
  215.     sh$ mysql mnogosearch < create.txt
  216.  
  217. PostgreSQL:
  218.     sh$ psql mnogosearch <create.txt
  219.  
  220. miniSQL:
  221.     sh$ msql mnogosearch <create.txt
  222.  
  223. Solid:
  224.     sh$ solsql "tcp localhost 1313" dba dba create.txt
  225.  
  226.  
  227. If you want to provide support for stop words, please do
  228.  
  229.     sh$ mysql mnogosearch <stop.lang1.txt
  230.     sh$ mysql mnogosearch <stop.lang2.txt
  231.  
  232. for all languages that you are planning to support.
  233.  
  234. Stop-list is a list of common words (such as 'am','he','in' etc.)
  235. that presents in almost every document, have little information value and
  236. therefore should not be stored in database.
  237.  
  238. If there is no stop-list for your language in this distribution, you are
  239. welcome to compose one and send it to general@mnogosearch.org - it will be
  240. included in next distribution.
  241.  
  242. If you want to make mnoGoSearch work in "multidict" mode, please
  243. create all required tables using multi.txt script.
  244.  
  245.  
  246. 6. Installing search scripts.
  247.  
  248. Copy search.cgi to your web-server cgi-bin directory or make Apache alias
  249. to mnoGoSearch bin directory. 
  250.  
  251.  
  252. Adding Ispell support
  253. =====================
  254. Ispell related stuff is described is /doc/ispell.txt
  255.  
  256.  
  257. Installation problems
  258. =====================
  259.  
  260.    * Each time you run 'configure', you must run 'make' again to
  261.      recompile.
  262.  
  263.      To prevent old configuration information or object files from being
  264.      used, run these commands before re-running 'configure':
  265.  
  266.              sh$ rm config.cache
  267.              sh$ make clean
  268.  
  269.    * If your compile fails with make errors, this can be because
  270.      you are using the wrong version of make.
  271.      The behavior of Solaris, FreeBSD, OpenBSD make is slightly different 
  272.      from GNU make. If you have make-related problems, 
  273.      you should use GNU make instead, often installed as gmake.
  274.      So, use gmake instead of make in step 3 after configure:
  275.  
  276.      GNU 'make' version 3.77 is known to work.
  277.  
  278. If above information doesn't help you, please feel free to contact mnoGoSearch
  279. mailing list <general@mnogosearch.org> (please post in English only).
  280.