1 =============================
2 Installation Guide for Installing Koha on Ubuntu Jaunty (9.04) with MySQL 5
3 =============================
5 Copyright (C) 2007, 2008 LibLime (http://liblime.com)
7 Original author: Joshua Ferraro (jmf AT liblime DOT com)
8 Modified for Ubuntu by: Chris Nighswonger (cnighswonger AT foundations DOT edu)
10 Feedback/bug reports: Koha Developer's List:
11 http://lists.koha.org/mailman/listinfo/koha-devel
13 This document last modified: 22 June 2009
15 Installation Instructions
16 =============================
18 All commands can be performed as a system user with sudo privileges,
19 as indicated or by running the command directly as root.
21 1. Prepare System and Install Dependencies
23 1.1 Install Ubuntu Jaunty via CD
25 See http://www.ubuntu.com/getubuntu/download
27 1.2 Set up your locale
29 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
30 This step is VERY IMPORTANT for a UNICODE compliant system. Please
31 read over the following document carefully:
33 http://wiki.koha.org/doku.php?id=encodingscratchpad
35 You can verify your system locale by typing the following command:
39 IMPORTANT: You _MUST_ follow all the steps outlined there for
40 Apache2, MySQL 5, etc. BEFORE you install Koha.
42 1.3 Install the Yaz and Zebra packages
44 Add Indexdata repository to your sources
46 $ sudo gedit /etc/apt/sources.list
48 Add those lines at the end of the file
50 # IndexData Repository
51 deb http://ftp.indexdata.dk/pub/ubuntu/ jaunty main
53 where jaunty is the name of your ubuntu version
57 Add Indexdata Key in order to be able to check signatures
60 $ wget http://ftp.indexdata.dk/debian/indexdata.asc
61 $ sudo apt-key add indexdata.asc
64 Run the following command to update your system:
67 $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
71 1.4.1 Option A: Download Koha via Git (optional)
73 $ sudo apt-get install git-core git-email
74 $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
76 $ git checkout -b myinstall origin
78 Note: for more information about Git, please see the Koha Git Usage Guide:
80 http://wiki.koha.org/doku.php?id=en:development:git_usage
82 1.4.2 Option B: Download Koha from http://download.koha.org
84 $ wget http://download.koha.org/koha-3.00.02.tar.gz
85 ( Note: use the latest stable version)
87 1.5 Install additional Ubuntu dependencies
89 IMPORTANT: You should only use CPAN for Perl dependencies which are NOT
90 available from the package maintainer. You have been warned!
92 Using the ubuntu.packages file included in the Koha source tree,
95 $ sudo dpkg --set-selections < install_misc/ubuntu.packages
97 Now start dselect (you may need to 'sudo apt-get install dselect'):
101 Choose [I]nstall and accept packages to be installed (hit return)
105 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
107 1.6 Install Perl dependencies that aren't packaged into Ubuntu Jaunty
110 Run the following command:
112 $ sudo cpan MARC::Crosswalk::DublinCore GD GD::Barcode::UPCE Email::Date \
113 HTML::Scrubber Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle
115 Note: you may need to run CPAN initialization if you've not run cpan
118 /etc/perl/CPAN/Config.pm initialized.
120 CPAN is the world-wide archive of perl resources. It consists of about
121 100 sites that all replicate the same contents all around the globe.
122 Many countries have at least one CPAN site already. The resources
123 found on CPAN are easily accessible with the CPAN.pm module. If you
124 want to use CPAN.pm, you have to configure it properly.
126 If you do not want to enter a dialog now, you can answer 'no' to this
127 question and I'll try to autoconfigure. (Note: you can revisit this
128 dialog anytime later by typing 'o conf init' at the cpan prompt.)
130 Are you ready for manual configuration? [yes]
132 When the configuration is completed CPAN will install the Perl modules.
134 2. Configuration of dependencies
136 2.1 Update root MySQL password (if dselect didn't do it for you already)
138 $ sudo mysqladmin password <password>
140 2.2 Create the Koha database
142 Create the database and user with associated privileges:
144 $ mysqladmin -uroot -p<password> create <kohadatabasename>
145 $ mysql -uroot -p<password>
147 Welcome to the MySQL monitor. Commands end with ; or \g.
148 Your MySQL connection id is 22
149 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
151 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
153 mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
154 Query OK, 0 rows affected (0.00 sec)
156 mysql> flush privileges;
157 Query OK, 0 rows affected (0.00 sec)
161 2.3 Test your SAX Parser and correct where necessary
163 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:
166 $ misc/sax_parser_print.pl
168 You should see something like::
170 XML::LibXML::SAX::Parser=HASH(0x81fe220)
172 If you're using PurePerl or Expat, you'll need to edit your
173 ini file, typically located at:
175 /etc/perl/XML/SAX/ParserDetails.ini
177 2.4 Install DBD::mysql Perl module
179 In order to handle UTF-8 correctly, Koha requires at least version 4.004
180 of the DBD::mysql Perl module. However, Debian Etch has a stable package
181 only for version 3.0008, so it is necessary to install the module from CPAN.
182 DBD::mysql's test suite needs to use a MySQL 'test' DB which doesn't exist
183 anymore. So there are two options to install DBD::mysql:
185 (1) install without test suite,
186 (2) install with test suite requiring a test MySQL DB creation.
188 2.4.1 Install without test suite
190 Force install DBD::mysql:
193 cpan> force install DBD::mysql
195 2.4.2 Create test database in order to install DBD::mysql
197 Because of DBD::mysql's test suite, it is necessary to temporarily create a
198 test database and user:
200 $ mysql -uroot -p<password>
202 Create the database and user with associated privileges:
204 Welcome to the MySQL monitor. Commands end with ; or \g.
205 Your MySQL connection id is 22
206 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
208 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
210 mysql> create database test;
211 Query OK, 1 row affected (0.00 sec)
213 mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
214 Query OK, 0 rows affected (0.00 sec)
215 (test database, user, and password can be different if need be)
217 mysql> flush privileges;
218 Query OK, 0 rows affected (0.00 sec)
222 Next install DBD::mysql:
226 cpan> o conf makepl_arg
227 (get current value of this CPAN parameter)
229 cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
231 cpan> install DBD::mysql
233 cpan> o conf makepl_arg ''
237 cpan> o conf makepl_arg '<old setting>'
239 (restore this setting so as to not interfere with future CPAN installs).
242 Finally, remove the test database:
244 $ mysql -uroot -p<password>
246 mysql> drop database test;
247 Query OK, 1 row affected (0.00 sec)
252 3. Run the Koha installer
260 4. Configure and start Apache
261 $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
262 (note that the path to koha-httpd.conf may be different depending on your
263 installation choices)
265 Add the following lines to /etc/apache2/ports.conf:
270 If not running named virtual hosts (The default koha installation does not use named virtual hosts.), comment out the following line:
274 Run the following commands:
276 $ sudo a2enmod rewrite
278 $ sudo apache2ctl restart
280 Note: you may still see the usual Apache default site if your VirtualHost
281 configuration isn't correct. The command "sudo a2dissite default" may be a
282 quick fix, but may have side-effects. See the Apache HTTPD manual section on
283 virtual hosts for full instructions.
285 5. Configure and start Zebra
287 Note: it's recommended that you daemonize the Zebra process and add it to your
288 startup profile. For a non-production test/development installation, running
289 Zebra from the command line can be useful. Pick from the two available options
290 below, or roll your own :-)
292 Note: it's also recommended that you create a Koha system user, which you will
293 have specified during the install process. Alternatively, Zebra can be
294 configured to run as the root user.
301 Option 1: run the Zebra processes from the command line:
304 $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
305 (note that the path to koha-conf.xml may be different depending on your
306 installation choices)
308 Note: the user you run Zebra as will be the only user with write permission
309 on the Zebra index; in development mode, you may wish to use your system
313 $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
315 Note: if you are running in this mode, you may wish to defer starting the
316 zebraqueue until you've run the web installer (see below).
318 Option 2: run the Zebra processes as daemons, and add to startup process:
320 Note that references to $SCRIPT_DIR refer to the directory where
321 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
324 $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon
325 (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
326 $ sudo update-rc.d koha-zebra-daemon defaults
327 ( Note: see man chkconfig(8) on other distros )
329 $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
332 $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh /etc/init.d/koha-zebraqueue-daemon
333 $ sudo update-rc.d koha-zebraqueue-daemon defaults
334 ( Note: see man chkconfig(8) on other distros )
336 $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
338 6. Run the Web Installer, populate the database, initial configuration of settings
340 Point your browser to http://<servername>:8080/
342 It should redirect you to the Web Installer where you can continue the setup.
343 You can install the sample data for libraries, patrons, etc. via the Web Installer
347 Once the installer has completed, you can import and index MARC records from the
348 command line thusly (Note: you can also use the 'Stage MARC records for import' from
349 the Tools area of Koha's Staff Client to import a batch of MARC records):
351 $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
352 (note: use the correct path to your koha-conf.xml)
355 Bibliographic data in MARC21 format
356 $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709
357 Authority data in MARC21 format
358 $ misc/migration-tools/bulkauthimport.pl -file /path/to/auth.iso2709
361 $ misc/migration-tools/rebuild_zebra.pl -b -w
363 Once the indexing has completed, you will be able to search for records in your
364 system. NOTE: if you don't run the Fast Index utility, and you have the index
365 updates scheduled as per 7.3 the indexing process will happen in the background,
366 but it will be orders of magnitude slower.
368 7.3 Schedule regular index updates
369 run rebuild_zebra.pl -b -a -z as a regular cron job, check misc/cronjobs/crontab.example
372 7.4 To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
373 change the <listen> options to listen on a TCP port; then restart the zebra daemon.
377 If you are upgrading from a previous installation of Koha 3, you can
380 perl Makefile.PL --prev-install-log /path/to/koha-install-log
385 Uninstall Instructions
386 =============================
388 $ sudo a2dissite koha
389 $ sudo rm /etc/apache2/sites-available/koha
390 $ sudo apache2ctl restart
392 $ sudo update-rc.d koha-zebra-daemon remove
393 $ sudo rm /etc/init.d/koha-zebra-daemon
395 2) Remove Database and Indexes
398 $ mysql -u<kohauser> -p<kohapassword>
399 > drop database koha;
402 $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
403 $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
405 3) Remove Koha Install Directories and Configuration Files
406 Don't forget about any crontab entries
408 Tested on the following operating environments
409 ==============================================
410 - Ubuntu Jaunty Jackalope 9.04
412 Installer Bug reports
413 =====================
414 Please log any installer bug reports at http://bugs.koha.org
417 =====================
418 This file is part of Koha
420 Koha is free software; you can redistribute it and/or modify it under the
421 terms of the GNU General Public License as published by the Free Software
422 Foundation; either version 2 of the License, or (at your option) any later
425 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
426 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
427 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
428 You should have received a copy of the GNU General Public License along with
429 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
430 Suite 330, Boston, MA 02111-1307 USA