Line # Revision Author
1 255 dpavlin INSTALL INSTRUCTIONS
2 49 dpavlin
3 Feel free to contact me via e-mail to dpavlin@rot13.org if those instructions
4 don't work for you.
5
6 132 dpavlin 1. You will need RDBMS (relational database management system) for index
7 files. PostgreSQL and SQLite are tested and supported.
8 49 dpavlin
9 Using any other database is quite easy, and involves editing of
10 132 dpavlin dbi_* parameters in global.conf [global] section (which you want
11 49 dpavlin to do anyway to specify user and password to connect to database).
12
13 132 dpavlin If you use PostgreSQL, you have to first create database:
14 49 dpavlin
15 52 dpavlin $ createdb webpac
16 49 dpavlin CREATE DATABASE
17
18 132 dpavlin 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 52 dpavlin Tables for index(es) will be created automatically on first run. If you
25 49 dpavlin 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 133 dpavlin 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 220 dpavlin 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 52 dpavlin 2. Use CPAN shell to install modules used:
43 49 dpavlin
44 52 dpavlin $ 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 255 dpavlin DBD::Pg or some other DBD driver like DBD::SQLite
54 52 dpavlin CGI::Application
55 HTML::Template
56 HTML::FillInForm
57 304 dpavlin SWISH::API
58 132 dpavlin XML::Simple
59 255 dpavlin Text::Iconv
60 776 dpavlin GDBM_File
61 255 dpavlin HTML::Entities (part of HTML::Parser)
62 52 dpavlin
63 CPAN shell will also download some more modules to satisfy dependencies.
64
65 255 dpavlin
66 52 dpavlin If you plan to use M$ Excel files for import (type=excel), you will need:
67
68 Spreadsheet::ParseExcel
69
70 132 dpavlin If you plan to use import from MARC files you will also need
71
72 627 dpavlin MARC::Record
73 132 dpavlin
74 255 dpavlin
75 2.1 Installation on Debian GNU/Linux
76
77 You will need following packages to get started:
78
79 perl
80 swish-e
81
82 and all additional packages which are dependencies.
83
84 You also don't have to install all CPAN modules manually. Just use
85 following Debian packages:
86
87 libtext-unaccent-perl
88 libconfig-inifiles-perl
89 libdbd-pg-perl or some other DBD driver
90 libdbd-sqlite-perl like DBD::SQLite
91 libhtml-template-perl
92 libxml-simple-perl
93 libtext-iconv-perl
94 libhtml-parser-perl
95
96 and install following packages by hand from CPAN
97 because they are not part of Debian distribution:
98
99 CGI::Application
100 HTML::FillInForm
101 304 dpavlin SWISH::API
102 255 dpavlin
103 and optionally some of those modules:
104
105 Spreadsheet::ParseExcel
106 627 dpavlin MARC::Record
107 255 dpavlin
108 627 dpavlin 3. You will need also IsisDB module if you are using ISIS as an import format.
109 Currenlty, this module is available only from development site
110 255 dpavlin
111 627 dpavlin http://svn.rot13.org/
112 255 dpavlin
113 627 dpavlin but, it should be available also through CPAN (meaning that it's stable and
114 tested). So, just try to install IsisDB using cpan first.
115 132 dpavlin
116 627 dpavlin WebPAC doesn't use OpenIsis anymore.
117 255 dpavlin
118 275 dpavlin 4. Edit global.conf and all2xml.conf to suit your needs. Comments inside
119 132 dpavlin those files should help get you started.
120
121 275 dpavlin 5. All perl code will use locale to do sorting. That also include indexes
122 which, while being RDBMS-based, also use perl sorting (because each
123 entry has ordinal number created by perl). So, be sure that LC_COLLATE
124 environment variable is configured for your locale (which also has to
125 be enabled, check dpkg-reconfigure locales if you are using Debian).