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