git.rot13.org Git - webpac/blob - INSTALL

   1 beta-beta-beta INSTALL INSTRUCTIONS
   2
   3 Feel free to contact me via e-mail to dpavlin@rot13.org if those instructions
   4 don't work for you.
   5
   6 1. You will need RDBMS (relational database management system) for index
   7    files. PostgreSQL and SQLite are tested and supported.
   8
   9    Using any other database is quite easy, and involves editing of
  10    dbi_* parameters in global.conf [global] section (which you want
  11    to do anyway to specify user and password to connect to database).
  12
  13    If you use PostgreSQL, you have to first create database:
  14
  15    $ createdb webpac
  16    CREATE DATABASE
  17
  18    If using SQLite, just specify file which SQLite will use (in global.conf)
  19    like this:
  20
  21    dbi_dbd=SQLite
  22    dbi_dsn=dbname=/data/webpac/index.sqlite
  23
  24    Tables for index(es) will be created automatically on first run. If you
  25    change data for index often, you might want to drop and re-create database
  26    to erase tables for indexes which are removed.
  27
  28    SQLite can be quite faster than PostgreSQL (for reference see SQLite
  29    site: http://www.hwaci.com/sw/sqlite/speed.html). Since WebPAC doesn't
  30    use advanced database facilities of PostgreSQL you would probably be
  31    better off with SQLite if you don't have PostgreSQL already installed.
  32
  33    If you are using SQLite, there is no need to specify dbi_user or dbi_pass.
  34    So, just leave them like this:
  35
  36    dbi_user=""
  37    dbi_passwd=""
  38
  39    If you specify dbi_user and than try to index using different user,
  40    you won't be able to write into database.
  41
  42 2. Use CPAN shell to install modules used:
  43
  44    $ sudo cpan
  45    cpan> install module_name
  46
  47    Modules which are needed:
  48
  49         Text::Unaccent          version 1.02 or higher, you might need
  50                                 to get this one from
  51                                 http://savannah.nongnu.org/projects/unac/
  52         Config::IniFiles
  53         DBD::Pg                 or some other DBD driver, you can also
  54                                 use the one which came with distribution
  55                                 (e.g. libdbd-pg-perl on Debian)
  56         CGI::Application
  57         HTML::Pager
  58         HTML::Template
  59         HTML::FillInForm
  60         SWISH
  61         SWISH::Fork             and of course, swish-e executable
  62                                 (e.g. swish-e package on Debian)
  63         XML::Simple
  64
  65    CPAN shell will also download some more modules to satisfy dependencies.
  66
  67    If you plan to use M$ Excel files for import (type=excel), you will need:
  68
  69         Spreadsheet::ParseExcel
  70
  71    If you plan to use import from MARC files you will also need
  72
  73         MARC
  74
  75 3. You will need OpenIsis if you are using ISIS as an import format.
  76    Currently, WebPAC uses OpenIsis 0.9.0 which *HAVE TO BE PATCHED*
  77    with special patch so that perl module OpenIsis.pm have close call
  78    (because there is hard-limit of 32 ISIS files in OpenIsis.pm, and that
  79    is too low for our use).
  80
  81    Get OpenIsis from:
  82         http://openisis.org/Doc/GetIt
  83
  84    Get patch for close from:
  85         http://www.rot13.org/~dpavlin/projects/openisis-0.9.0-perl_close.diff
  86
  87    Unpack OpenIsis archive and apply patch -p0 to source tree. Type make, and
  88    than:
  89
  90         cd perl
  91         perl Makefile.PL
  92         make
  93         sudo make install
  94
  95 4. edit global.conf and all2xml.conf to suit your needs. Comments inside
  96    those files should help get you started.
  97