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
115 There is a known but benign error in the test case for Barcode::Code128,
116 which is required by PDF::Reuse::Barcode. If this module is not installed,
117 you can do a forced installation of Barcode::Code128.
119 Note: you may need to run CPAN initialization if you've not run cpan
122 /etc/perl/CPAN/Config.pm initialized.
124 CPAN is the world-wide archive of perl resources. It consists of about
125 100 sites that all replicate the same contents all around the globe.
126 Many countries have at least one CPAN site already. The resources
127 found on CPAN are easily accessible with the CPAN.pm module. If you
128 want to use CPAN.pm, you have to configure it properly.
130 If you do not want to enter a dialog now, you can answer 'no' to this
131 question and I'll try to autoconfigure. (Note: you can revisit this
132 dialog anytime later by typing 'o conf init' at the cpan prompt.)
134 Are you ready for manual configuration? [yes]
136 When the configuration is completed CPAN will install the Perl modules.
138 2. Configuration of dependencies
140 2.1 Update root MySQL password (if dselect didn't do it for you already)
142 $ sudo mysqladmin password <password>
144 2.2 Create the Koha database
146 Create the database and user with associated privileges:
148 $ mysqladmin -uroot -p<password> create <kohadatabasename>
149 $ mysql -uroot -p<password>
151 Welcome to the MySQL monitor. Commands end with ; or \g.
152 Your MySQL connection id is 22
153 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
155 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
157 mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
158 Query OK, 0 rows affected (0.00 sec)
160 mysql> flush privileges;
161 Query OK, 0 rows affected (0.00 sec)
165 2.3 Test your SAX Parser and correct where necessary
167 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:
170 $ misc/sax_parser_print.pl
172 You should see something like::
174 XML::LibXML::SAX::Parser=HASH(0x81fe220)
176 If you're using PurePerl or Expat, you'll need to edit your
177 ini file, typically located at:
179 /etc/perl/XML/SAX/ParserDetails.ini
181 2.4 Install DBD::mysql Perl module
183 In order to handle UTF-8 correctly, Koha requires at least version 4.004
184 of the DBD::mysql Perl module. However, Debian Etch has a stable package
185 only for version 3.0008, so it is necessary to install the module from CPAN.
186 DBD::mysql's test suite needs to use a MySQL 'test' DB which doesn't exist
187 anymore. So there are two options to install DBD::mysql:
189 (1) install without test suite,
190 (2) install with test suite requiring a test MySQL DB creation.
192 2.4.1 Install without test suite
194 Force install DBD::mysql:
197 cpan> force install DBD::mysql
199 2.4.2 Create test database in order to install DBD::mysql
201 Because of DBD::mysql's test suite, it is necessary to temporarily create a
202 test database and user:
204 $ mysql -uroot -p<password>
206 Create the database and user with associated privileges:
208 Welcome to the MySQL monitor. Commands end with ; or \g.
209 Your MySQL connection id is 22
210 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
212 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
214 mysql> create database test;
215 Query OK, 1 row affected (0.00 sec)
217 mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
218 Query OK, 0 rows affected (0.00 sec)
219 (test database, user, and password can be different if need be)
221 mysql> flush privileges;
222 Query OK, 0 rows affected (0.00 sec)
226 Next install DBD::mysql:
230 cpan> o conf makepl_arg
231 (get current value of this CPAN parameter)
233 cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
235 cpan> install DBD::mysql
237 cpan> o conf makepl_arg ''
241 cpan> o conf makepl_arg '<old setting>'
243 (restore this setting so as to not interfere with future CPAN installs).
246 Finally, remove the test database:
248 $ mysql -uroot -p<password>
250 mysql> drop database test;
251 Query OK, 1 row affected (0.00 sec)
256 3. Run the Koha installer
264 4. Configure and start Apache
265 $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
266 (note that the path to koha-httpd.conf may be different depending on your
267 installation choices)
269 Add the following lines to /etc/apache2/ports.conf:
274 Run the following commands:
276 $ sudo a2enmod rewrite
278 $ sudo apache2ctl restart
280 5. Configure and start Zebra
282 Note: it's recommended that you daemonize the Zebra process and add it to your
283 startup profile. For a non-production test/development installation, running
284 Zebra from the command line can be useful. Pick from the two available options
285 below, or roll your own :-)
287 Note: it's also recommended that you create a Koha system user, which you will
288 have specified during the install process. Alternatively, Zebra can be
289 configured to run as the root user.
291 Option 1: run the Zebra processes from the command line:
294 $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
295 (note that the path to koha-conf.xml may be different depending on your
296 installation choices)
298 Note: the user you run Zebra as will be the only user with write permission
299 on the Zebra index; in development mode, you may wish to use your system
303 $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
305 Note: if you are running in this mode, you may wish to defer starting the
306 zebraqueue until you've run the web installer (see below).
308 Option 2: run the Zebra processes as daemons, and add to startup process:
310 Note that references to $SCRIPT_DIR refer to the directory where
311 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
314 $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon
315 (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
316 $ sudo update-rc.d koha-zebra-daemon defaults
317 ( Note: see man chkconfig(8) on other distros )
319 $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
322 $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh /etc/init.d/koha-zebraqueue-daemon
323 $ sudo update-rc.d koha-zebraqueue-daemon defaults
324 ( Note: see man chkconfig(8) on other distros )
326 $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
328 6. Run the Web Installer, populate the database, initial configuration of settings
330 Point your browser to http://<servername>:8080/
332 It should redirect you to the Web Installer where you can continue the setup.
333 You can install the sample data for libraries, patrons, etc. via the Web Installer
337 Once the installer has completed, you can import and index MARC records from the
338 command line thusly (Note: you can also use the 'Stage MARC records for import' from
339 the Tools area of Koha's Staff Client to import a batch of MARC records):
341 $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
342 (note: use the correct path to your koha-conf.xml)
345 $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709
348 $ misc/migration-tools/rebuild_zebra.pl -b -w
350 Once the indexing has completed, you will be able to search for records in your
351 system. NOTE: if you don't run the Fast Index utility, and you have the zebraqueue
352 daemon running, the indexin process will happen in the background, but it will be
353 orders of magnitude slower.
355 To enable the SRU servers, you'll need to edit your koha-conf.xml and change the
356 <listen> options to listen on a TCP port; then restart the zebra daemon.
360 If you are upgrading from a previous installation of Koha 3, you can
363 perl Makefile.PL --prev-install-log /path/to/koha-install-log
368 Uninstall Instructions
369 =============================
371 $ sudo a2dissite koha
372 $ sudo rm /etc/apache2/sites-available/koha
373 $ sudo apache2ctl restart
375 $ sudo update-rc.d koha-zebra-daemon remove
376 $ sudo update-rc.d koha-zebraqueue-daemon remove
377 $ sudo rm /etc/init.d/koha-zebra-daemon
378 $ sudo rm /etc/init.d/koha-zebraqueue-daemon
380 2) Remove Koha Databases
383 $ mysql -u<kohauser> -p<kohapassword>
384 > drop database koha;
387 $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
388 $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
390 3) Remove Koha Install Directories and Configuration Files
392 Tested on the following operating environments
393 ==============================================
396 Installer Bug reports
397 =====================
398 Please send any installer bug reports to jmf AT liblime DOT com
401 =====================
402 This file is part of Koha
404 Koha is free software; you can redistribute it and/or modify it under the
405 terms of the GNU General Public License as published by the Free Software
406 Foundation; either version 2 of the License, or (at your option) any later
409 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
410 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
411 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
412 You should have received a copy of the GNU General Public License along with
413 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
414 Suite 330, Boston, MA 02111-1307 USA