another fix for repeatable fields
[webpac] / 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 2. Use CPAN shell to install modules used:
34
35    $ sudo cpan
36    cpan> install module_name
37
38    Modules which are needed:
39
40         Text::Unaccent          version 1.02 or higher, you might need
41                                 to get this one from
42                                 http://savannah.nongnu.org/projects/unac/
43         Config::IniFiles
44         DBD::Pg                 or some other DBD driver, you can also
45                                 use the one which came with distribution
46                                 (e.g. libdbd-pg-perl on Debian)
47         CGI::Application
48         HTML::Pager
49         HTML::Template
50         HTML::FillInForm
51         SWISH
52         SWISH::Fork             and of course, swish-e executable
53                                 (e.g. swish-e package on Debian)
54         XML::Simple
55
56    CPAN shell will also download some more modules to satisfy dependencies.
57
58    If you plan to use M$ Excel files for import (type=excel), you will need:
59
60         Spreadsheet::ParseExcel
61
62    If you plan to use import from MARC files you will also need
63
64         MARC
65
66 3. You will need OpenIsis if you are using ISIS as an import format.
67    Currently, WebPAC uses OpenIsis 0.9.0 which *HAVE TO BE PATCHED*
68    with special patch so that perl module OpenIsis.pm have close call
69    (because there is hard-limit of 32 ISIS files in OpenIsis.pm, and that
70    is too low for our use).
71
72    Get OpenIsis from:
73         http://openisis.org/Doc/GetIt
74
75    Get patch for close from:
76         http://www.rot13.org/~dpavlin/projects/openisis-0.9.0-perl_close.diff
77
78    Unpack OpenIsis archive and apply patch -p0 to source tree. Type make, and
79    than:
80
81         cd perl
82         perl Makefile.PL
83         make
84         sudo make install
85
86 4. edit global.conf and all2xml.conf to suit your needs. Comments inside
87    those files should help get you started.
88