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 1.2 Set up your locale
28 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
29 This step is VERY IMPORTANT for a UNICODE compliant system. Please
30 read over the following document carefully:
32 http://wiki.koha.org/doku.php?id=encodingscratchpad
34 IMPORTANT: You _MUST_ follow all the steps outlined there for
35 Apache2, MySQL 5, etc. BEFORE you install Koha.
37 1.3 Set up apt sources for Git, Yaz and Zebra packages
39 Edit your /etc/apt/sources.list file and add the following:
42 deb http://ftp.indexdata.dk/debian etch main
43 deb-src http://ftp.indexdata.dk/debian etch main
46 deb http://www.backports.org/debian etch-backports main contrib non-free
48 Backports packages are signed with a key you can install as follows:
51 $ sudo apt-get install debian-backports-keyring
53 The Index Data packages are signed with a key you can install as follows:
55 $ wget http://ftp.indexdata.dk/debian/indexdata.asc
56 $ sudo apt-key add indexdata.asc
58 Run the following command to update your system:
61 $ sudo apt-get -t etch-backports install git-core git-email
62 $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
66 1.4.1 Option A: Download Koha via Git (optional)
68 $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
70 $ git checkout -b myinstall origin
72 Note: for more information about Git, please see the Koha Git Usage Guide:
74 http://wiki.koha.org/doku.php?id=en:development:git_usage
76 1.4.2 Option B: Download Koha from http://download.koha.org
78 $ wget http://download.koha.org/koha-3.00.00-beta.tar.gz
79 ( Note: use the latest stable version)
81 1.5 Install additional Debian dependencies
83 IMPORTANT: You should only use CPAN for Perl dependencies which are NOT
84 available from the package maintainer. You have been warned!
86 Using the debian.packages file included in the Koha source tree,
89 $ sudo dpkg --set-selections < install_misc/debian.packages
95 Choose [I]nstall and accept packages to be installed (hit return)
99 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
101 1.6 Install Perl dependencies that aren't packaged into Debian Etch
104 Run the following command:
106 $ sudo cpan MARC::Record Class::Accessor MARC::Charset MARC::File::XML \
107 Net::Z3950::ZOOM HTML::Template::Pro MARC::Crosswalk::DublinCore \
108 PDF::Reuse PDF::Reuse::Barcode Data::ICal GD::Barcode::UPCE \
109 XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE Schedule::At
111 There is a known but benign error in the test case for Barcode::Code128,
112 which is required by PDF::Reuse::Barcode. If this module is not installed,
113 you can do a forced installation of Barcode::Code128.
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 Run the following commands:
272 $ sudo a2enmod rewrite
274 $ sudo apache2ctl restart
276 5. Configure and start Zebra
278 Note: it's recommended that you daemonize the Zebra process and add it to your
279 startup profile. For a non-production test/development installation, running
280 Zebra from the command line can be useful. Pick from the two available options
281 below, or roll your own :-)
283 Note: it's also recommended that you create a Koha system user, which you will
284 have specified during the install process. Alternatively, Zebra can be
285 configured to run as the root user.
287 Option 1: run the Zebra processes from the command line:
290 $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
291 (note that the path to koha-conf.xml may be different depending on your
292 installation choices)
294 Note: the user you run Zebra as will be the only user with write permission
295 on the Zebra index; in development mode, you may wish to use your system
299 $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
301 Note: if you are running in this mode, you may wish to defer starting the
302 zebraqueue until you've run the web installer (see below).
304 Option 2: run the Zebra processes as daemons, and add to startup process:
306 Note that references to $SCRIPT_DIR refer to the directory where
307 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
310 $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon
311 (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
312 $ sudo update-rc.d koha-zebra-daemon defaults
313 ( Note: see man chkconfig(8) on other distros )
315 $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
318 $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh /etc/init.d/koha-zebraqueue-daemon
319 $ sudo update-rc.d koha-zebraqueue-daemon defaults
320 ( Note: see man chkconfig(8) on other distros )
322 $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
324 6. Run the Web Installer, populate the database, initial configuration of settings
326 Point your browser to http://<servername>:8080/
328 It should redirect you to the Web Installer where you can continue the setup.
329 You can install the sample data for libraries, patrons, etc. via the Web Installer
333 Once the installer has completed, you can import and index MARC records from the
334 command line thusly (Note: you can also use the 'Stage MARC records for import' from
335 the Tools area of Koha's Staff Client to import a batch of MARC records):
337 $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
338 (note: use the correct path to your koha-conf.xml)
341 $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709
344 $ misc/migration-tools/rebuild_zebra.pl -b -w
346 Once the indexing has completed, you will be able to search for records in your
347 system. NOTE: if you don't run the Fast Index utility, and you have the zebraqueue
348 daemon running, the indexin process will happen in the background, but it will be
349 orders of magnitude slower.
351 To enable the SRU servers, you'll need to edit your koha-conf.xml and change the
352 <listen> options to listen on a TCP port; then restart the zebra daemon.
356 If you are upgrading from a previous installation of Koha 3, you can
359 perl Makefile.PL --prev-install-log /path/to/koha-install-log
364 Uninstall Instructions
365 =============================
367 $ sudo a2dissite koha
368 $ sudo rm /etc/apache2/sites-available/koha
369 $ sudo apache2ctl restart
371 $ sudo update-rc.d koha-zebra-daemon remove
372 $ sudo update-rc.d koha-zebraqueue-daemon remove
373 $ sudo rm /etc/init.d/koha-zebra-daemon
374 $ sudo rm /etc/init.d/koha-zebraqueue-daemon
376 2) Remove Koha Databases
379 $ mysql -u<kohauser> -p<kohapassword>
380 > drop database koha;
383 $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
384 $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
386 3) Remove Koha Install Directories and Configuration Files
388 Tested on the following operating environments
389 ==============================================
392 Installer Bug reports
393 =====================
394 Please send any installer bug reports to jmf AT liblime DOT com
397 =====================
398 This file is part of Koha
400 Koha is free software; you can redistribute it and/or modify it under the
401 terms of the GNU General Public License as published by the Free Software
402 Foundation; either version 2 of the License, or (at your option) any later
405 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
406 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
407 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
408 You should have received a copy of the GNU General Public License along with
409 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
410 Suite 330, Boston, MA 02111-1307 USA