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 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
18 This step is VERY IMPORTANT for a UNICODE compliant system. Please
19 read over the following document carefully:
21 http://wiki.koha.org/doku.php?id=encodingscratchpad
23 1. Prepare System and Install Dependencies
25 1.1 Install Debian Etch via Businesscard CD
27 See http://www.debian.org/releases/etch/debian-installer/
29 1.2 Set up apt sources for Git, Yaz and Zebra packages
31 Edit your /etc/apt/sources.list file and add the following:
34 deb http://ftp.indexdata.dk/debian etch main
35 deb-src http://ftp.indexdata.dk/debian etch main
38 deb http://www.backports.org/debian etch-backports main contrib non-free
40 Backports packages are signed with a key you can install as follows:
43 $ sudo apt-get install debian-backports-keyring
45 The Index Data packages are signed with a key you can install as follows:
47 $ wget http://ftp.indexdata.dk/debian/indexdata.asc
48 $ sudo apt-key add indexdata.asc
50 Run the following command to update your system:
53 $ sudo apt-get -t etch-backports install git-core git-email
54 $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
58 1.3.1 Option A: Download Koha via Git (optional)
60 $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
62 $ git checkout -b myinstall origin
64 Note: for more information about Git, please see the Koha Git Usage Guide:
66 http://wiki.koha.org/doku.php?id=en:development:git_usage
68 1.3.2 Option B: Download Koha from koha.org
70 1.4 Install additional Debian dependencies
72 IMPORTANT: You should only use CPAN for Perl dependencies which are NOT available from the package maintainer.
75 Using the debian.packages file included in the Koha source tree,
78 $ sudo dpkg --set-selections < install_misc/debian.packages
84 Choose [I]nstall and accept packages to be installed (hit return)
88 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
90 1.5 Install Perl dependencies that aren't packaged into Debian Etch
93 Run the following command:
95 $ sudo cpan MARC::Record Class::Accessor MARC::Charset MARC::File::XML \
96 Net::Z3950::ZOOM HTML::Template::Pro MARC::Crosswalk::DublinCore \
97 PDF::Reuse PDF::Reuse::Barcode Data::ICal GD::Barcode::UPCE \
98 XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE Schedule::At
100 There is a known but benign error in the test case for Barcode::Code128,
101 which is required by PDF::Reuse::Barcode. If this module is not installed,
102 you can do a forced installation of Barcode::Code128.
104 Note: you may need to run CPAN initialization if you've not run cpan
107 /etc/perl/CPAN/Config.pm initialized.
109 CPAN is the world-wide archive of perl resources. It consists of about
110 100 sites that all replicate the same contents all around the globe.
111 Many countries have at least one CPAN site already. The resources
112 found on CPAN are easily accessible with the CPAN.pm module. If you
113 want to use CPAN.pm, you have to configure it properly.
115 If you do not want to enter a dialog now, you can answer 'no' to this
116 question and I'll try to autoconfigure. (Note: you can revisit this
117 dialog anytime later by typing 'o conf init' at the cpan prompt.)
119 Are you ready for manual configuration? [yes]
121 When the configuration is completed CPAN will install the Perl modules.
123 2. Configuration of dependencies
125 2.1 Update root MySQL password (if dselect didn't do it for you already)
127 $ sudo mysqladmin password <password>
129 2.2 Create the Koha database
131 Create the database and user with associated privileges:
133 $ mysqladmin -uroot -p<password> create database <kohadatabasename>
134 $ mysql -uroot -p<password>
136 Welcome to the MySQL monitor. Commands end with ; or \g.
137 Your MySQL connection id is 22
138 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
140 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
142 mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
143 Query OK, 0 rows affected (0.00 sec)
145 mysql> flush privileges;
146 Query OK, 0 rows affected (0.00 sec)
150 2.3 Test your SAX Parser and correct where necessary
152 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:
154 $ misc/sax_parser_print.pl
156 You should see something like::
158 XML::LibXML::SAX::Parser=HASH(0x81fe220)
160 If you're using PurePerl or Expat, you'll need to edit your
161 ini file, typically located at:
163 /etc/perl/XML/SAX/ParserDetails.ini
165 2.4 Create test database in order to install DBD::mysql
167 In order to handle UTF-8 correctly, Koha requires at least version 4.004
168 of the DBD::mysql Perl module. However, Debian Etch has a stable package
169 only for version 3.0008, so it is necessary to install the module from CPAN.
170 Because of DBD::mysql's test suite, it is necessary to temporarily create a
171 test database and user:
173 $ mysql -uroot -p<password>
175 Create the database and user with associated privileges:
177 Welcome to the MySQL monitor. Commands end with ; or \g.
178 Your MySQL connection id is 22
179 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
181 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
183 mysql> create database test;
184 Query OK, 1 row affected (0.00 sec)
186 mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
187 Query OK, 0 rows affected (0.00 sec)
188 (test database, user, and password can be different if need be)
190 mysql> flush privileges;
191 Query OK, 0 rows affected (0.00 sec)
195 Next install DBD::mysql:
199 cpan> o conf makepl_arg
200 (get current value of this CPAN parameter)
202 cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
204 cpan> install DBD::mysql
206 cpan> o conf makepl_arg ''
207 (clear this setting to not interface with future CPAN installs).
210 Finally, remove the test database:
212 $ mysql -uroot -p<password>
214 mysql> drop database test;
215 Query OK, 1 row affected (0.00 sec)
220 3. Run the Koha installer
228 4. Configure and start Apache
229 $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
230 (note that the path to koha-httpd.conf may be different depending on your
231 installation choices)
233 Add the following lines to /etc/apache2/ports.conf:
238 Run the following commands:
240 $ sudo a2enmod rewrite
242 $ sudo apache2ctl restart
244 5. Configure and start Zebra
246 Note: it's recommended that you daemonize the Zebra process and add it to your
247 startup profile. For a non-production test/development installation, running
248 Zebra from the command line can be useful. Pick from the two available options
249 below, or roll your own :-)
251 Note: it's also recommended that you create a Koha system user, which you will
252 have specified during the install process. Alternatively, Zebra can be
253 configured to run as the root user.
255 Option 1: run the Zebra processes from the command line:
258 $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
259 (note that the path to koha-conf.xml may be different depending on your
260 installation choices)
262 Note: the user you run Zebra as will be the only user with write permission
263 on the Zebra index; in development mode, you may wish to use your system
267 $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
269 Note: if you are running in this mode, you may wish to defer starting the
270 zebraqueue until you've run the web installer (see below).
272 Option 2: run the Zebra processes as daemons, and add to startup process:
274 Note that references to $SCRIPT_DIR refer to the directory where
275 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
278 $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon
279 (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
280 $ sudo update-rc.d koha-zebra-daemon defaults
281 ( Note: see man chkconfig(8) on other distros )
283 $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
286 $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh /etc/init.d/koha-zebraqueue-daemon
287 $ sudo update-rc.d koha-zebraqueue-daemon defaults
288 ( Note: see man chkconfig(8) on other distros )
290 $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
292 6. Run the Web Installer, populate the database, initial configuration of settings
294 Point your browser to http://<servername>:8080/
296 It should redirect you to the Web installer where you can continue the setup.
298 Uninstall Instructions
299 =============================
301 $ sudo a2dissite koha
302 $ sudo rm /etc/apache2/sites-available/koha
303 $ sudo apache2ctl restart
305 $ sudo update-rc.d koha-zebra-daemon remove
306 $ sudo update-rc.d koha-zebraqueue-daemon remove
307 $ sudo rm /etc/init.d/koha-zebra-daemon
308 $ sudo rm /etc/init.d/koha-zebraqueue-daemon
310 2) Remove Koha Databases
313 $ mysql -u<kohauser> -p<kohapassword>
314 > drop database koha;
317 $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
318 $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
320 3) Remove Koha Install Directories and Configuration Files
322 Tested on the following operating environments
323 ==============================================
326 Installer Bug reports
327 =====================
328 Please send any installer bug reports to jmf AT liblime DOT com
331 =====================
332 This file is part of Koha
334 Koha is free software; you can redistribute it and/or modify it under the
335 terms of the GNU General Public License as published by the Free Software
336 Foundation; either version 2 of the License, or (at your option) any later
339 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
340 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
341 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
342 You should have received a copy of the GNU General Public License along with
343 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
344 Suite 330, Boston, MA 02111-1307 USA