1 =============================
2 Installation Guide for Installing Koha on Debian Etch with MySQL 5
3 =============================
5 Copyright (C) 2007, LibLime
7 Maintainer: Joshua Ferraro (jmf AT liblime DOT com)
8 Feedback/bug reports: jmf AT liblime DOT com
9 This document last modified: 29 December 2007
11 Installation Instructions
12 =============================
14 All commands can be performed as a system user with sudo privileges,
15 as indicated or by running the command directly as root.
17 1. Prepare System and Install Dependencies
19 1.1 Install Debian Etch via Businesscard CD
21 See http://www.debian.org/releases/etch/debian-installer/
23 1.2 Set up your locale
25 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
26 This step is VERY IMPORTANT for a UNICODE compliant system. Please
27 read over the following document carefully:
29 http://wiki.koha.org/doku.php?id=encodingscratchpad
31 IMPORTANT: You _MUST_ follow all the steps outlined there for
32 Apache2, MySQL 5, etc. BEFORE you install Koha.
34 1.3 Set up apt sources for Git, Yaz and Zebra packages
36 Edit your /etc/apt/sources.list file and add the following:
39 deb http://ftp.indexdata.dk/debian etch main
40 deb-src http://ftp.indexdata.dk/debian etch main
43 deb http://www.backports.org/debian etch-backports main contrib non-free
45 Backports packages are signed with a key you can install as follows:
48 $ sudo apt-get install debian-backports-keyring
50 The Index Data packages are signed with a key you can install as follows:
52 $ wget http://ftp.indexdata.dk/debian/indexdata.asc
53 $ sudo apt-key add indexdata.asc
55 Run the following command to update your system:
58 $ sudo apt-get -t etch-backports install git-core git-email
59 $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
63 1.4.1 Option A: Download Koha via Git (optional)
65 $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
67 $ git checkout -b myinstall origin
69 Note: for more information about Git, please see the Koha Git Usage Guide:
71 http://wiki.koha.org/doku.php?id=en:development:git_usage
73 1.4.2 Option B: Download Koha from http://download.koha.org
75 $ wget http://download.koha.org/koha-3.00.00-beta.tar.gz
76 ( Note: use the latest stable version)
78 1.5 Install additional Debian dependencies
80 IMPORTANT: You should only use CPAN for Perl dependencies which are NOT
81 available from the package maintainer. You have been warned!
83 Using the debian.packages file included in the Koha source tree,
86 $ sudo dpkg --set-selections < install_misc/debian.packages
92 Choose [I]nstall and accept packages to be installed (hit return)
96 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
98 1.6 Install Perl dependencies that aren't packaged into Debian Etch
101 Run the following command:
103 $ sudo cpan MARC::Record Class::Accessor MARC::Charset MARC::File::XML \
104 Net::Z3950::ZOOM HTML::Template::Pro MARC::Crosswalk::DublinCore \
105 PDF::Reuse PDF::Reuse::Barcode Data::ICal GD::Barcode::UPCE \
106 XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE Schedule::At
108 There is a known but benign error in the test case for Barcode::Code128,
109 which is required by PDF::Reuse::Barcode. If this module is not installed,
110 you can do a forced installation of Barcode::Code128.
112 Note: you may need to run CPAN initialization if you've not run cpan
115 /etc/perl/CPAN/Config.pm initialized.
117 CPAN is the world-wide archive of perl resources. It consists of about
118 100 sites that all replicate the same contents all around the globe.
119 Many countries have at least one CPAN site already. The resources
120 found on CPAN are easily accessible with the CPAN.pm module. If you
121 want to use CPAN.pm, you have to configure it properly.
123 If you do not want to enter a dialog now, you can answer 'no' to this
124 question and I'll try to autoconfigure. (Note: you can revisit this
125 dialog anytime later by typing 'o conf init' at the cpan prompt.)
127 Are you ready for manual configuration? [yes]
129 When the configuration is completed CPAN will install the Perl modules.
131 2. Configuration of dependencies
133 2.1 Update root MySQL password (if dselect didn't do it for you already)
135 $ sudo mysqladmin password <password>
137 2.2 Create the Koha database
139 Create the database and user with associated privileges:
141 $ mysqladmin -uroot -p<password> create <kohadatabasename>
142 $ mysql -uroot -p<password>
144 Welcome to the MySQL monitor. Commands end with ; or \g.
145 Your MySQL connection id is 22
146 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
148 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
150 mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
151 Query OK, 0 rows affected (0.00 sec)
153 mysql> flush privileges;
154 Query OK, 0 rows affected (0.00 sec)
158 2.3 Test your SAX Parser and correct where necessary
160 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:
163 $ misc/sax_parser_print.pl
165 You should see something like::
167 XML::LibXML::SAX::Parser=HASH(0x81fe220)
169 If you're using PurePerl or Expat, you'll need to edit your
170 ini file, typically located at:
172 /etc/perl/XML/SAX/ParserDetails.ini
174 2.4 Install DBD::mysql Perl module
176 In order to handle UTF-8 correctly, Koha requires at least version 4.004
177 of the DBD::mysql Perl module. However, Debian Etch has a stable package
178 only for version 3.0008, so it is necessary to install the module from CPAN.
179 DBD::mysql's test suite needs to use a MySQL 'test' DB which doesn't exist
180 anymore. So there are two options to install DBD::mysql:
182 (1) install without test suite,
183 (2) install with test suite requiring a test MySQL DB creation.
185 2.4.1 Install without test suite
187 Force install DBD::mysql:
190 cpan> force install DBD::mysql
192 2.4.2 Create test database in order to install DBD::mysql
194 Because of DBD::mysql's test suite, it is necessary to temporarily create a
195 test database and user:
197 $ mysql -uroot -p<password>
199 Create the database and user with associated privileges:
201 Welcome to the MySQL monitor. Commands end with ; or \g.
202 Your MySQL connection id is 22
203 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
205 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
207 mysql> create database test;
208 Query OK, 1 row affected (0.00 sec)
210 mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
211 Query OK, 0 rows affected (0.00 sec)
212 (test database, user, and password can be different if need be)
214 mysql> flush privileges;
215 Query OK, 0 rows affected (0.00 sec)
219 Next install DBD::mysql:
223 cpan> o conf makepl_arg
224 (get current value of this CPAN parameter)
226 cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
228 cpan> install DBD::mysql
230 cpan> o conf makepl_arg ''
234 cpan> o conf makepl_arg '<old setting>'
236 (restore this setting so as to not interfere with future CPAN installs).
239 Finally, remove the test database:
241 $ mysql -uroot -p<password>
243 mysql> drop database test;
244 Query OK, 1 row affected (0.00 sec)
249 3. Run the Koha installer
257 4. Configure and start Apache
258 $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
259 (note that the path to koha-httpd.conf may be different depending on your
260 installation choices)
262 Add the following lines to /etc/apache2/ports.conf:
267 Run the following commands:
269 $ sudo a2enmod rewrite
271 $ sudo apache2ctl restart
273 5. Configure and start Zebra
275 Note: it's recommended that you daemonize the Zebra process and add it to your
276 startup profile. For a non-production test/development installation, running
277 Zebra from the command line can be useful. Pick from the two available options
278 below, or roll your own :-)
280 Note: it's also recommended that you create a Koha system user, which you will
281 have specified during the install process. Alternatively, Zebra can be
282 configured to run as the root user.
284 Option 1: run the Zebra processes from the command line:
287 $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
288 (note that the path to koha-conf.xml may be different depending on your
289 installation choices)
291 Note: the user you run Zebra as will be the only user with write permission
292 on the Zebra index; in development mode, you may wish to use your system
296 $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
298 Note: if you are running in this mode, you may wish to defer starting the
299 zebraqueue until you've run the web installer (see below).
301 Option 2: run the Zebra processes as daemons, and add to startup process:
303 Note that references to $SCRIPT_DIR refer to the directory where
304 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
307 $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon
308 (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
309 $ sudo update-rc.d koha-zebra-daemon defaults
310 ( Note: see man chkconfig(8) on other distros )
312 $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
315 $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh /etc/init.d/koha-zebraqueue-daemon
316 $ sudo update-rc.d koha-zebraqueue-daemon defaults
317 ( Note: see man chkconfig(8) on other distros )
319 $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
321 6. Run the Web Installer, populate the database, initial configuration of settings
323 Point your browser to http://<servername>:8080/
325 It should redirect you to the Web Installer where you can continue the setup.
326 You can install the sample data for libraries, patrons, etc. via the Web Installer
330 Once the installer has completed, you can import and index MARC records from the
331 command line thusly (Note: you can also use the 'Stage MARC records for import' from
332 the Tools area of Koha's Staff Client to import a batch of MARC records):
334 $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
335 (note: use the correct path to your koha-conf.xml)
338 $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709
341 $ misc/migration-tools/rebuild_zebra.pl -b -w
343 Once the indexing has completed, you will be able to search for records in your
344 system. NOTE: if you don't run the Fast Index utility, and you have the zebraqueue
345 daemon running, the indexin process will happen in the background, but it will be
346 orders of magnitude slower.
348 To enable the SRU servers, you'll need to edit your koha-conf.xml and change the
349 <listen> options to listen on a TCP port; then restart the zebra daemon.
353 If you are upgrading from a previous installation of Koha 3, you can
356 perl Makefile.PL --prev-install-log /path/to/koha-install-log
361 Uninstall Instructions
362 =============================
364 $ sudo a2dissite koha
365 $ sudo rm /etc/apache2/sites-available/koha
366 $ sudo apache2ctl restart
368 $ sudo update-rc.d koha-zebra-daemon remove
369 $ sudo update-rc.d koha-zebraqueue-daemon remove
370 $ sudo rm /etc/init.d/koha-zebra-daemon
371 $ sudo rm /etc/init.d/koha-zebraqueue-daemon
373 2) Remove Koha Databases
376 $ mysql -u<kohauser> -p<kohapassword>
377 > drop database koha;
380 $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
381 $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
383 3) Remove Koha Install Directories and Configuration Files
385 Tested on the following operating environments
386 ==============================================
389 Installer Bug reports
390 =====================
391 Please send any installer bug reports to jmf AT liblime DOT com
394 =====================
395 This file is part of Koha
397 Koha is free software; you can redistribute it and/or modify it under the
398 terms of the GNU General Public License as published by the Free Software
399 Foundation; either version 2 of the License, or (at your option) any later
402 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
403 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
404 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
405 You should have received a copy of the GNU General Public License along with
406 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
407 Suite 330, Boston, MA 02111-1307 USA