1 =============================
2 Installation Guide for Installing Koha on Debian Etch with MySQL 5
3 =============================
5 Copyright (C) 2007, 2008 LibLime (http://liblime.com)
7 Maintainer: Joshua Ferraro (jmf AT liblime DOT com)
9 Feedback/bug reports: Koha Developer's List:
10 http://lists.koha.org/mailman/listinfo/koha-devel
12 This document last modified: 30 April 2008
14 Installation Instructions
15 =============================
17 All commands can be performed as a system user with sudo privileges,
18 as indicated or by running the command directly as root.
20 1. Prepare System and Install Dependencies
22 1.1 Install Debian Etch via Businesscard CD
24 See http://www.debian.org/releases/etch/debian-installer/
26 WARNING: use Perl 5.8 (a library Koha depends on,
27 MARC::File::XML may not work with Perl 5.10, see:
28 http://bugs.koha.org/cgi-bin/bugzilla/show_bug.cgi?id=2309),
30 1.2 Set up your locale
32 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
33 This step is VERY IMPORTANT for a UNICODE compliant system. Please
34 read over the following document carefully:
36 http://wiki.koha.org/doku.php?id=encodingscratchpad
38 IMPORTANT: You _MUST_ follow all the steps outlined there for
39 Apache2, MySQL 5, etc. BEFORE you install Koha.
41 1.3 Set up apt sources for Git, Yaz and Zebra packages
43 Edit your /etc/apt/sources.list file and add the following:
46 deb http://ftp.indexdata.dk/debian etch main
47 deb-src http://ftp.indexdata.dk/debian etch main
50 deb http://www.backports.org/debian etch-backports main contrib non-free
52 Backports packages are signed with a key you can install as follows:
55 $ sudo apt-get install debian-backports-keyring
57 The Index Data packages are signed with a key you can install as follows:
59 $ wget http://ftp.indexdata.dk/debian/indexdata.asc
60 $ sudo apt-key add indexdata.asc
62 Run the following command to update your system:
65 $ sudo apt-get -t etch-backports install git-core git-email
66 $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
70 1.4.1 Option A: Download Koha via Git (optional)
72 $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
74 $ git checkout -b myinstall origin
76 Note: for more information about Git, please see the Koha Git Usage Guide:
78 http://wiki.koha.org/doku.php?id=en:development:git_usage
80 1.4.2 Option B: Download Koha from http://download.koha.org
82 $ wget http://download.koha.org/koha-3.00.00-beta.tar.gz
83 ( Note: use the latest stable version)
85 1.5 Install additional Debian dependencies
87 IMPORTANT: You should only use CPAN for Perl dependencies which are NOT
88 available from the package maintainer. You have been warned!
90 Using the debian.packages file included in the Koha source tree,
93 $ sudo dpkg --set-selections < install_misc/debian.packages
99 Choose [I]nstall and accept packages to be installed (hit return)
103 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
105 1.6 Install Perl dependencies that aren't packaged into Debian Etch
108 Run the following command:
110 $ sudo cpan MARC::Record Class::Accessor MARC::Charset MARC::File::XML \
111 Net::Z3950::ZOOM HTML::Template::Pro MARC::Crosswalk::DublinCore \
112 PDF::Reuse PDF::Reuse::Barcode Data::ICal GD::Barcode::UPCE \
113 XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE Schedule::At
116 1.6.1 A Perl library Koha depends on, MARC::File::XML may not work with Perl
117 5.10, see: http://bugs.koha.org/cgi-bin/bugzilla/show_bug.cgi?id=2309),
119 1.6.2 Recent versions of CGI::Session have caused some issues for users;
120 as of this release date, we suggest downloading the CGI::Session::serialize::yaml
121 tarball direct from CPAN and install it directly rather than using the cpan command
123 1.6.3 There is a known but benign error in the test case for Barcode::Code128,
124 which is required by PDF::Reuse::Barcode. If this module is not installed,
125 you can do a forced installation of Barcode::Code128.
127 Note: you may need to run CPAN initialization if you've not run cpan
130 /etc/perl/CPAN/Config.pm initialized.
132 CPAN is the world-wide archive of perl resources. It consists of about
133 100 sites that all replicate the same contents all around the globe.
134 Many countries have at least one CPAN site already. The resources
135 found on CPAN are easily accessible with the CPAN.pm module. If you
136 want to use CPAN.pm, you have to configure it properly.
138 If you do not want to enter a dialog now, you can answer 'no' to this
139 question and I'll try to autoconfigure. (Note: you can revisit this
140 dialog anytime later by typing 'o conf init' at the cpan prompt.)
142 Are you ready for manual configuration? [yes]
144 When the configuration is completed CPAN will install the Perl modules.
146 2. Configuration of dependencies
148 2.1 Update root MySQL password (if dselect didn't do it for you already)
150 $ sudo mysqladmin password <password>
152 2.2 Create the Koha database
154 Create the database and user with associated privileges:
156 $ mysqladmin -uroot -p<password> create <kohadatabasename>
157 $ mysql -uroot -p<password>
159 Welcome to the MySQL monitor. Commands end with ; or \g.
160 Your MySQL connection id is 22
161 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
163 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
165 mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
166 Query OK, 0 rows affected (0.00 sec)
168 mysql> flush privileges;
169 Query OK, 0 rows affected (0.00 sec)
173 2.3 Test your SAX Parser and correct where necessary
175 You must be sure you're using the XML::LibXML SAX parser, not Expat or PurePerl, both of which have outstanding bugs with pre-composed characters. You can test your SAX parser by running:
178 $ misc/sax_parser_print.pl
180 You should see something like::
182 XML::LibXML::SAX::Parser=HASH(0x81fe220)
184 If you're using PurePerl or Expat, you'll need to edit your
185 ini file, typically located at:
187 /etc/perl/XML/SAX/ParserDetails.ini
189 2.4 Install DBD::mysql Perl module
191 In order to handle UTF-8 correctly, Koha requires at least version 4.004
192 of the DBD::mysql Perl module. However, Debian Etch has a stable package
193 only for version 3.0008, so it is necessary to install the module from CPAN.
194 DBD::mysql's test suite needs to use a MySQL 'test' DB which doesn't exist
195 anymore. So there are two options to install DBD::mysql:
197 (1) install without test suite,
198 (2) install with test suite requiring a test MySQL DB creation.
200 2.4.1 Install without test suite
202 Force install DBD::mysql:
205 cpan> force install DBD::mysql
207 2.4.2 Create test database in order to install DBD::mysql
209 Because of DBD::mysql's test suite, it is necessary to temporarily create a
210 test database and user:
212 $ mysql -uroot -p<password>
214 Create the database and user with associated privileges:
216 Welcome to the MySQL monitor. Commands end with ; or \g.
217 Your MySQL connection id is 22
218 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
220 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
222 mysql> create database test;
223 Query OK, 1 row affected (0.00 sec)
225 mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
226 Query OK, 0 rows affected (0.00 sec)
227 (test database, user, and password can be different if need be)
229 mysql> flush privileges;
230 Query OK, 0 rows affected (0.00 sec)
234 Next install DBD::mysql:
238 cpan> o conf makepl_arg
239 (get current value of this CPAN parameter)
241 cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
243 cpan> install DBD::mysql
245 cpan> o conf makepl_arg ''
249 cpan> o conf makepl_arg '<old setting>'
251 (restore this setting so as to not interfere with future CPAN installs).
254 Finally, remove the test database:
256 $ mysql -uroot -p<password>
258 mysql> drop database test;
259 Query OK, 1 row affected (0.00 sec)
264 3. Run the Koha installer
272 4. Configure and start Apache
273 $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
274 (note that the path to koha-httpd.conf may be different depending on your
275 installation choices)
277 Add the following lines to /etc/apache2/ports.conf:
282 Run the following commands:
284 $ sudo a2enmod rewrite
286 $ sudo apache2ctl restart
288 Note: you may still see the usual Apache default site if your VirtualHost
289 configuration isn't correct. The command "sudo a2dissite default" may be a
290 quick fix, but may have side-effects. See the Apache HTTPD manual section on
291 virtual hosts for full instructions.
293 5. Configure and start Zebra
295 Note: it's recommended that you daemonize the Zebra process and add it to your
296 startup profile. For a non-production test/development installation, running
297 Zebra from the command line can be useful. Pick from the two available options
298 below, or roll your own :-)
300 Note: it's also recommended that you create a Koha system user, which you will
301 have specified during the install process. Alternatively, Zebra can be
302 configured to run as the root user.
304 Option 1: run the Zebra processes from the command line:
307 $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
308 (note that the path to koha-conf.xml may be different depending on your
309 installation choices)
311 Note: the user you run Zebra as will be the only user with write permission
312 on the Zebra index; in development mode, you may wish to use your system
316 $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
318 Note: if you are running in this mode, you may wish to defer starting the
319 zebraqueue until you've run the web installer (see below).
321 Option 2: run the Zebra processes as daemons, and add to startup process:
323 Note that references to $SCRIPT_DIR refer to the directory where
324 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
327 $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon
328 (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
329 $ sudo update-rc.d koha-zebra-daemon defaults
330 ( Note: see man chkconfig(8) on other distros )
332 $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
335 $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh /etc/init.d/koha-zebraqueue-daemon
336 $ sudo update-rc.d koha-zebraqueue-daemon defaults
337 ( Note: see man chkconfig(8) on other distros )
339 $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
341 6. Run the Web Installer, populate the database, initial configuration of settings
343 Point your browser to http://<servername>:8080/
345 It should redirect you to the Web Installer where you can continue the setup.
346 You can install the sample data for libraries, patrons, etc. via the Web Installer
350 Once the installer has completed, you can import and index MARC records from the
351 command line thusly (Note: you can also use the 'Stage MARC records for import' from
352 the Tools area of Koha's Staff Client to import a batch of MARC records):
354 $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
355 (note: use the correct path to your koha-conf.xml)
358 Bibliographic data in MARC21 format
359 $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709
360 Authority data in MARC21 format
361 $ misc/migration-tools/bulkauthimport.pl -file /path/to/auth.iso2709
364 $ misc/migration-tools/rebuild_zebra.pl -b -w
366 Once the indexing has completed, you will be able to search for records in your
367 system. NOTE: if you don't run the Fast Index utility, and you have the index
368 updates scheduled as per 7.3 the indexing process will happen in the background,
369 but it will be orders of magnitude slower.
371 7.3 Schedule regular index updates
372 run rebuild_zebra.pl -b -a -z as a regular cron job, check misc/cronjobs/crontab.example
375 7.4 To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
376 change the <listen> options to listen on a TCP port; then restart the zebra daemon.
380 If you are upgrading from a previous installation of Koha 3, you can
383 perl Makefile.PL --prev-install-log /path/to/koha-install-log
388 Uninstall Instructions
389 =============================
391 $ sudo a2dissite koha
392 $ sudo rm /etc/apache2/sites-available/koha
393 $ sudo apache2ctl restart
395 $ sudo update-rc.d koha-zebra-daemon remove
396 $ sudo rm /etc/init.d/koha-zebra-daemon
398 2) Remove Database and Indexes
401 $ mysql -u<kohauser> -p<kohapassword>
402 > drop database koha;
405 $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
406 $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
408 3) Remove Koha Install Directories and Configuration Files
409 Don't forget about any crontab entries
411 Tested on the following operating environments
412 ==============================================
415 Installer Bug reports
416 =====================
417 Please send any installer bug reports to jmf AT liblime DOT com
420 =====================
421 This file is part of Koha
423 Koha is free software; you can redistribute it and/or modify it under the
424 terms of the GNU General Public License as published by the Free Software
425 Foundation; either version 2 of the License, or (at your option) any later
428 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
429 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
430 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
431 You should have received a copy of the GNU General Public License along with
432 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
433 Suite 330, Boston, MA 02111-1307 USA