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 or by running the command directly as root.
17 Your locale should be set to UTF-8, as should Apache and MySQL.
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 Using the debian.packages file included in the Koha source tree,
70 $ sudo dpkg --set-selections < install_misc/debian.packages
76 Choose [I]nstall and accept packages to be installed (hit return)
80 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
82 1.5 Install Perl dependencies that aren't packaged into Debian Etch
85 Run the following command:
87 $ sudo cpan MARC::Record Class::Accessor MARC::Charset MARC::File::XML Net::Z3950::ZOOM HTML::Template::Pro MARC::Crosswalk::DublinCore PDF::Reuse PDF::Reuse::Barcode Data::ICal GD::Barcode::UPCE XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE Schedule::At
89 Note: you may need to run CPAN initialization if you've not run cpan
92 /etc/perl/CPAN/Config.pm initialized.
94 CPAN is the world-wide archive of perl resources. It consists of about
95 100 sites that all replicate the same contents all around the globe.
96 Many countries have at least one CPAN site already. The resources
97 found on CPAN are easily accessible with the CPAN.pm module. If you
98 want to use CPAN.pm, you have to configure it properly.
100 If you do not want to enter a dialog now, you can answer 'no' to this
101 question and I'll try to autoconfigure. (Note: you can revisit this
102 dialog anytime later by typing 'o conf init' at the cpan prompt.)
104 Are you ready for manual configuration? [yes]
106 When the configuration is completed CPAN will install the Perl modules.
108 2. Configuration of dependencies
110 2.1 Update root MySQL password (if dselect didn't do it for you already)
112 $ sudo mysqladmin password <password>
114 2.2 Create the Koha database
116 $ mysqladmin -uroot -p<password> create database <kohadatabasename>
117 $ mysql -uroot -p<password>
119 Create the database and user with associated privileges:
121 Welcome to the MySQL monitor. Commands end with ; or \g.
122 Your MySQL connection id is 22
123 Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
125 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
127 mysql> create database <kohadatabasename>;
128 Query OK, 1 row affected (0.00 sec)
130 mysql> grant all on <kohadatabasename>.* to <kohadatabaseuser> identified by '<kohadatabaseuserpassword>';
131 Query OK, 0 rows affected (0.00 sec)
133 mysql> flush privileges;
134 Query OK, 0 rows affected (0.00 sec)
138 3. Run the Koha installer
146 4. Configure and start Apache
147 $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
148 (note that the path to koha-httpd.conf may be different depending on your
149 installation choices)
151 $ sudo a2enmod rewrite
152 $ sudo a2ensite koha && /etc/init.d/apache2 reload
154 5. Configure and start Zebra
156 Note: it's recommended that you daemonize the Zebra process and add it to your
157 startup profile. For a non-production test/development installation, running
158 Zebra from the command line can be useful. Pick from the two available options
159 below, or roll your own :-)
161 Note: it's also recommended that you create a Koha system user, which you will
162 have specified during the install process. Alternatively, Zebra can be
163 configured to run as the root user.
165 Option 1: run the Zebra processes from the command line:
168 $ sudo ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
169 (note that the path to koha-conf.xml may be different depending on your
170 installation choices)
173 $ sudo ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
175 Option 2: run the Zebra processes as daemons, and add to startup process:
178 $ sudo ln -s misc/bin/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon
179 $ update-rc.d koha-zebra-daemon defaults
180 ( Note: see man chkconfig(8) on other distros )
181 $ misc/bin/koha-zebra-ctl.sh start
184 $ sudo ln -s misc/bin/koha-zebraqueue-ctl.sh /etc/init.d/koha-zebraqueue-daemon
185 $ update-rc.d koha-zebraqueue-daemon defaults
186 ( Note: see man chkconfig(8) on other distros )
188 $ misc/bin/koha-zebraqueue-ctl.sh start
190 6. Run the Web Installer, populate the database, initial configuration of settings
192 Point your browser to http://<servername>:8080/
194 It should redirect you to the Web installer where you can continue the setup.
196 Uninstall Instructions
197 =============================
199 2) Remove install folder for Koha
200 3) Remove /etc/apache2/sites-available/koha
203 Tested on the following operating environments
204 ==============================================
207 Installer Bug reports
208 =====================
209 Please send any installer bug reports to jmf AT liblime DOT com
212 =====================
213 This file is part of Koha
215 Koha is free software; you can redistribute it and/or modify it under the
216 terms of the GNU General Public License as published by the Free Software
217 Foundation; either version 2 of the License, or (at your option) any later
220 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
221 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
222 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
223 You should have received a copy of the GNU General Public License along with
224 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
225 Suite 330, Boston, MA 02111-1307 USA