added SQLite parametar sqlite_handle_binary_nulls

[webpac] / INSTALL

diff --git a/INSTALL b/INSTALL
index 1f6bef5..0217d75 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -3,20 +3,95 @@ beta-beta-beta INSTALL INSTRUCTIONS
 Feel free to contact me via e-mail to dpavlin@rot13.org if those instructions
 don't work for you.
 
-1. You will need PostgreSQL (for now)
+1. You will need RDBMS (relational database management system) for index
+   files. PostgreSQL and SQLite are tested and supported.
 
    Using any other database is quite easy, and involves editing of
-   dbi_* parametars in isis2xml.conf [global] section (which you want
+   dbi_* parameters in global.conf [global] section (which you want
    to do anyway to specify user and password to connect to database).
 
-   Then, create database:
+   If you use PostgreSQL, you have to first create database:
 
-   dpavlin@llin:~$ createdb webpac
+   $ createdb webpac
    CREATE DATABASE
 
-   Tabels for index(es) will be created automatically on first run. If you
+   If using SQLite, just specify file which SQLite will use (in global.conf)
+   like this:
+
+   dbi_dbd=SQLite
+   dbi_dsn=dbname=/data/webpac/index.sqlite
+
+   Tables for index(es) will be created automatically on first run. If you
    change data for index often, you might want to drop and re-create database
    to erase tables for indexes which are removed.
 
-2. Use cpan shell to install modules used:
+   SQLite can be quite faster than PostgreSQL (for reference see SQLite
+   site: http://www.hwaci.com/sw/sqlite/speed.html). Since WebPAC doesn't
+   use advanced database facilities of PostgreSQL you would probably be
+   better off with SQLite if you don't have PostgreSQL already installed.
+
+   If you are using SQLite, there is no need to specify dbi_user or dbi_pass.
+   So, just leave them like this:
+
+   dbi_user=""
+   dbi_passwd=""
+
+   If you specify dbi_user and than try to index using different user,
+   you won't be able to write into database.
+
+2. Use CPAN shell to install modules used:
+
+   $ sudo cpan
+   cpan> install module_name
+
+   Modules which are needed:
+
+       Text::Unaccent          version 1.02 or higher, you might need
+                               to get this one from
+                               http://savannah.nongnu.org/projects/unac/
+       Config::IniFiles
+       DBD::Pg                 or some other DBD driver, you can also
+                               use the one which came with distribution
+                               (e.g. libdbd-pg-perl on Debian)
+       CGI::Application
+       HTML::Pager
+       HTML::Template
+       HTML::FillInForm
+       SWISH
+       SWISH::Fork             and of course, swish-e executable
+                               (e.g. swish-e package on Debian)
+       XML::Simple
+
+   CPAN shell will also download some more modules to satisfy dependencies.
+
+   If you plan to use M$ Excel files for import (type=excel), you will need:
+
+       Spreadsheet::ParseExcel
+
+   If you plan to use import from MARC files you will also need
+
+       MARC
+
+3. You will need OpenIsis if you are using ISIS as an import format.
+   Currently, WebPAC uses OpenIsis 0.9.0 which *HAVE TO BE PATCHED*
+   with special patch so that perl module OpenIsis.pm have close call
+   (because there is hard-limit of 32 ISIS files in OpenIsis.pm, and that
+   is too low for our use).
+
+   Get OpenIsis from:
+       http://openisis.org/Doc/GetIt
+
+   Get patch for close from:
+       http://www.rot13.org/~dpavlin/projects/openisis-0.9.0-perl_close.diff
+
+   Unpack OpenIsis archive and apply patch -p0 to source tree. Type make, and
+   than:
+
+       cd perl
+       perl Makefile.PL
+       make
+       sudo make install
+
+4. edit global.conf and all2xml.conf to suit your needs. Comments inside
+   those files should help get you started.