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: 22 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/devel/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:
42 $ sudo apt-get install debian-backports-keyring
44 The Index Data packages are signed with a key you can install as follows:
46 $ wget http://ftp.indexdata.dk/debian/indexdata.asc
47 $ sudo apt-key add indexdata.asc
49 Run the following command to update your system:
52 $ sudo apt-get -t etch-backports install git-core git-email
53 $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
55 1.3 Download Koha via Git
57 $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
59 $ git checkout -b myinstall origin
61 Note: for more information about Git, please see the Koha Git Usage Guide:
63 http://wiki.koha.org/doku.php?id=en:development:git_usage
65 1.4 Install additional Debian dependencies
67 IMPORTANT: You should only use CPAN for Perl dependencies which are NOT available from the package maintainer.
70 Using the debian.packages file included in the Koha source tree,
73 $ sudo dpkg --set-selections < install_misc/debian.packages
79 Choose [I]nstall and accept packages to be installed (hit return)
83 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
85 1.5 Install Perl dependencies that aren't packaged into Debian Etch
88 Run the following command:
90 $ sudo cpan MARC::Record Class::Accessor MARC::Charset MARC::File::XML \
91 Net::Z3950::ZOOM HTML::Template::Pro MARC::Crosswalk::DublinCore \
92 PDF::Reuse PDF::Reuse::Barcode Data::ICal GD::Barcode::UPCE \
93 XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE Schedule::At
95 There is a known but benign error in the test case for Barcode::Code128,
96 which is required by PDF::Reuse::Barcode. If this module is not installed,
97 you can do a forced installation of Barcode::Code128.
99 Note: you may need to run CPAN initialization if you've not run cpan
102 /etc/perl/CPAN/Config.pm initialized.
104 CPAN is the world-wide archive of perl resources. It consists of about
105 100 sites that all replicate the same contents all around the globe.
106 Many countries have at least one CPAN site already. The resources
107 found on CPAN are easily accessible with the CPAN.pm module. If you
108 want to use CPAN.pm, you have to configure it properly.
110 If you do not want to enter a dialog now, you can answer 'no' to this
111 question and I'll try to autoconfigure. (Note: you can revisit this
112 dialog anytime later by typing 'o conf init' at the cpan prompt.)
114 Are you ready for manual configuration? [yes]
116 When the configuration is completed CPAN will install the Perl modules.
118 2. Configuration of dependencies
120 2.1 Update root MySQL password (if dselect didn't do it for you already)
122 $ sudo mysqladmin password <password>
124 2.2 Create the Koha database
126 $ mysqladmin -uroot -p<password> create database <kohadatabasename>
127 $ mysql -uroot -p<password>
129 Create the database and user with associated privileges:
131 Welcome to the MySQL monitor. Commands end with ; or \g.
132 Your MySQL connection id is 22
133 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
135 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
137 mysql> create database <kohadatabasename>;
138 Query OK, 1 row affected (0.00 sec)
140 mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
141 Query OK, 0 rows affected (0.00 sec)
143 mysql> flush privileges;
144 Query OK, 0 rows affected (0.00 sec)
148 2.3 Create test database in order to install DBD::mysql
150 In order to handle UTF-8 correctly, Koha requires at least version 4.004
151 of the DBD::mysql Perl module. However, Debian Etch has a stable package
152 only for version 3.0008, so it is necessary to install the module from CPAN.
153 Because of DBD::mysql's test suite, it is necessary to temporarily create a
154 test database and user:
156 $ mysql -uroot -p<password>
158 Create the database and user with associated privileges:
160 Welcome to the MySQL monitor. Commands end with ; or \g.
161 Your MySQL connection id is 22
162 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
164 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
166 mysql> create database test;
167 Query OK, 1 row affected (0.00 sec)
169 mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
170 Query OK, 0 rows affected (0.00 sec)
171 (test database, user, and password can be different if need be)
173 mysql> flush privileges;
174 Query OK, 0 rows affected (0.00 sec)
178 Next install DBD::mysql:
182 cpan> o conf makepl_arg
183 (get current value of this CPAN parameter)
185 cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
187 cpan> install DBD::mysql
189 cpan> o conf makepl_arg ''
190 (clear this setting to not interface with future CPAN installs).
193 Finally, remove the test database:
195 $ mysql -uroot -p<password>
197 mysql> drop database test;
198 Query OK, 1 row affected (0.00 sec)
203 3. Run the Koha installer
211 4. Configure and start Apache
212 $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
213 (note that the path to koha-httpd.conf may be different depending on your
214 installation choices)
216 Add the following lines to /etc/apache2/ports.conf:
221 Run the following commands:
223 $ sudo a2enmod rewrite
225 $ sudo apache2ctl restart
227 5. Configure and start Zebra
229 Note: it's recommended that you daemonize the Zebra process and add it to your
230 startup profile. For a non-production test/development installation, running
231 Zebra from the command line can be useful. Pick from the two available options
232 below, or roll your own :-)
234 Note: it's also recommended that you create a Koha system user, which you will
235 have specified during the install process. Alternatively, Zebra can be
236 configured to run as the root user.
238 Option 1: run the Zebra processes from the command line:
241 $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
242 (note that the path to koha-conf.xml may be different depending on your
243 installation choices)
245 Note: the user you run Zebra as will be the only user with write permission
246 on the Zebra index; in development mode, you may wish to use your system
250 $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
252 Note: if you are running in this mode, you may wish to defer starting the
253 zebraqueue until you've run the web installer (see below).
255 Option 2: run the Zebra processes as daemons, and add to startup process:
257 Note that references to $SCRIPT_DIR refer to the directory where
258 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
261 $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon
262 (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
263 $ sudo update-rc.d koha-zebra-daemon defaults
264 ( Note: see man chkconfig(8) on other distros )
266 $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
269 $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh /etc/init.d/koha-zebraqueue-daemon
270 $ sudo update-rc.d koha-zebraqueue-daemon defaults
271 ( Note: see man chkconfig(8) on other distros )
273 $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
275 6. Run the Web Installer, populate the database, initial configuration of settings
277 Point your browser to http://<servername>:8080/
279 It should redirect you to the Web installer where you can continue the setup.
281 Uninstall Instructions
282 =============================
284 $ sudo a2dissite koha
285 $ sudo rm /etc/apache2/sites-available/koha
286 $ sudo apache2ctl restart
288 $ sudo update-rc.d koha-zebra-daemon remove
289 $ sudo update-rc.d koha-zebraqueue-daemon remove
290 $ sudo rm /etc/init.d/koha-zebra-daemon
291 $ sudo rm /etc/init.d/koha-zebraqueue-daemon
293 2) Remove Koha Database
296 $ mysql -u<kohauser> -p<kohapassword>
297 > drop database koha;
300 $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
301 $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
303 3) Remove Koha Install Directories
305 Tested on the following operating environments
306 ==============================================
309 Installer Bug reports
310 =====================
311 Please send any installer bug reports to jmf AT liblime DOT com
314 =====================
315 This file is part of Koha
317 Koha is free software; you can redistribute it and/or modify it under the
318 terms of the GNU General Public License as published by the Free Software
319 Foundation; either version 2 of the License, or (at your option) any later
322 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
323 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
324 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
325 You should have received a copy of the GNU General Public License along with
326 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
327 Suite 330, Boston, MA 02111-1307 USA