Main Koha release repository
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

380 lines
13 KiB

Installation Guide for Installing Koha on Ubuntu Lucid Lynx (10.04 LTS) with MySQL 5
Copyright (C) 2007, 2008 LibLime (
Some parts copyright 2010 Chris Nighswonger
Original author: Joshua Ferraro
Modified for Ubuntu by: Chris Nighswonger (cnighswonger AT foundations DOT edu)
Feedback/bug reports: Koha Developer's List:
This document last modified: 20 Marchp 2012
Installation Instructions
All commands can be performed as a system user with sudo privileges,
as indicated or by running the command directly as root.
1. Prepare System and Install Dependencies
1.1 Install Ubuntu Lucid Lynx via CD
1.2 Set up your locale
Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
This step is VERY IMPORTANT for a UNICODE compliant system. Please
read over the following document carefully:
You can verify your system locale by typing the following command:
$ locale
IMPORTANT: You _MUST_ follow all the steps outlined there for
Apache2, MySQL 5, etc. BEFORE you install Koha.
1.3 Get Koha
1.3.1 Option A: Download Koha via Git (optional)
$ sudo apt-get install git-core git-email
$ git clone git:// kohaclone
$ cd kohaclone
$ git checkout -b myinstall origin
Note: for more information about Git, please see the Koha Git Usage Guide:
1.3.2 Option B: Download Koha from
$ wget
( Note: use the latest stable version)
1.4 Install additional Ubuntu dependencies
IMPORTANT: You should only use CPAN for Perl dependencies which are NOT
available from the package maintainer. You have been warned!
Using the ubuntu.packages file included in the Koha source tree,
run the following:
$ sudo dpkg --set-selections < install_misc/ubuntu.packages
Now start dselect (you may need to 'sudo apt-get install dselect'):
$ sudo dselect
Choose [I]nstall and accept packages to be installed (hit return)
(may take a while)
Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
Note: If you are installing on an older version of Ubuntu, not all of the
packages listed in ubuntu.packages may be available as packages. You
will want to verify which ones are installed and which ones not.
This can be done by running the following command:
$ install_misc/ | grep none
When tracking down any "(none)" results, note that sometimes Ubuntu does the
right thing and installs a later, differently named version of the package in
place. To see if this is happening, it is useful to run a command like:
$ dpkg --get-selections | grep [base_package_name]
1.5 Install Perl dependencies that aren't packaged into Ubuntu Lucid Lynx
Run the following command:
$ sudo cpan HTTP::OAI Locale::Currency::Format Memoize::Memcached \
PDF::API2::Simple Storable Text::CSV::Encoded CHI \
Note: you may need to run CPAN initialization if you've not run cpan
/etc/perl/CPAN/ initialized.
CPAN is the world-wide archive of perl resources. It consists of about
100 sites that all replicate the same contents all around the globe.
Many countries have at least one CPAN site already. The resources
found on CPAN are easily accessible with the module. If you
want to use, you have to configure it properly.
If you do not want to enter a dialog now, you can answer 'no' to this
question and I'll try to autoconfigure. (Note: you can revisit this
dialog anytime later by typing 'o conf init' at the cpan prompt.)
Are you ready for manual configuration? [yes]
When the configuration is completed CPAN will install the Perl modules.
2. Configuration of dependencies
2.1 Update root MySQL password (if dselect didn't do it for you already)
$ sudo mysqladmin password <password>
2.2 Create the Koha database
Create the database and user with associated privileges:
$ mysqladmin -uroot -p<password> create <kohadatabasename>
$ mysql -uroot -p<password>
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 22
Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
Query OK, 0 rows affected (0.00 sec)
mysql> flush privileges;
Query OK, 0 rows affected (0.00 sec)
mysql> quit
2.3 Test your SAX Parser and correct where necessary
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:
$ cd koha
$ misc/
You should see something like::
If you're using PurePerl or Expat, you'll need to edit your
ini file, typically located at:
You will need to move the entire section for '[XML::LibXML::SAX::Parser]'
to the bottom of the ini file.
3. Run the Koha installer
$ perl Makefile.PL
( answer questions )
$ make
$ make test
$ sudo make install
4. Configure and start Apache
$ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
(note that the path to koha-httpd.conf may be different depending on your
installation choices)
Add the following lines to /etc/apache2/ports.conf:
Listen 80
Listen 8080
If not running named virtual hosts (The default koha installation does not use
named virtual hosts.), comment out the following line:
NameVirtualHost *:80
Run the following commands:
$ sudo a2enmod rewrite deflate
$ sudo a2ensite koha
$ sudo apache2ctl restart
Note: you may still see the usual Apache default site if your VirtualHost
configuration isn't correct. The command "sudo a2dissite default" may be a
quick fix, but may have side-effects. See the Apache HTTPD manual section on
virtual hosts for full instructions.
5. Configure and start Zebra
Note: it's recommended that you daemonize the Zebra process and add it to your
startup profile. For a non-production test/development installation, running
Zebra from the command line can be useful. Pick from the two available options
below, or roll your own :-)
Note: it's also recommended that you create a Koha system user, which you will
have specified during the install process. Alternatively, Zebra can be
configured to run as the root user.
To add a user do:
$ sudo adduser koha
Option 1: run the Zebra processes from the command line:
5.1.1 Zebra Search Server
This process send responses to search requests sent by Koha or
Z39.50/SRU/SRW clients.
$ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
(note that the path to koha-conf.xml may be different depending on your
installation choices)
Note: the user you run Zebra as will be the only user with write permission
on the Zebra index; in development mode, you may wish to use your
system user.
5.1.2 Zebra Indexer
Added/updated/deleted records in Koha MySQL database must be indexed
into Zebra. A specific script must be launched each time a bibliographic
or an authority record is edited.
$ sudo -u ${KOHA_USER} misc/migration_tools/rebuild_zebra -z -b -a
NOTE: This script should be run as the kohauser (the default is 'koha').
Option 2: run the Zebra process as a daemon, and add to startup process:
Note that references to $SCRIPT_DIR refer to the directory where
Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
5.2.1 Zebra Search Server
$ sudo ln -s ${SCRIPT_DIR}/ /etc/init.d/koha-zebra-daemon
(Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
$ sudo update-rc.d koha-zebra-daemon defaults
( Note: see man chkconfig(8) on other distros )
$ sudo ${SCRIPT_DIR}/ start
5.2.2 Zebra Indexer
Add an entry in Koha user crontab to scheduled added/updated/deleted records
indexing by Zebra with this command:
<path/to/koha>/misc/migration_tools/rebuild_zebra -z -b -a
See check misc/cronjobs/crontab.example for usage examples.
NOTE: This job should be setup under the kohauser (the default is 'koha').
You can also configure zebra-indexing as an background daemon, see
6. Run the Web Installer, populate the database, initial configuration of settings
Point your browser to http://<servername>:8080/
It should redirect you to the Web Installer where you can continue the setup.
You can install the sample data for libraries, patrons, etc. via the Web Installer
7. What next?
Once the installer has completed, you can import and index MARC records from the
command line thusly (Note: you can also use the 'Stage MARC records for import' from
the Tools area of Koha's Staff Client to import a batch of MARC records):
$ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
(note: use the correct path to your koha-conf.xml)
7.1 Import:
Bibliographic data in MARC21 format
$ misc/migration_tools/ -file /path/to/marc.iso2709
Authority data in MARC21 format
$ misc/migration_tools/ -file /path/to/auth.iso2709
7.2 Fast Index:
$ misc/migration_tools/ -b -w
Once the indexing has completed, you will be able to search for records in your system.
NOTE: This script should be run as the kohauser (the default is 'koha').
7.3 Schedule regular index updates
You need to run -b -a -z as a regular cron job in orde to pick up new bibs
and items as you add them. Check misc/cronjobs/crontab.example for usage examples. See 7.0 above.
NOTE: This job should be setup under the kohauser (the default is 'koha').
You can also indexing in background, see 5.2.2 above
7.4 To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
change the <listen> options to listen on a TCP port; then restart the zebra daemon.
If you are running in another language other than english, please
switch to english before doing the upgrade, the templating system has
changed and the templates will need to be regenerated.
Once you have upgraded, please regenerate your templates in your
chosen languages.
If you are upgrading from a previous installation of Koha 3.x, you can
use the following:
./ -u -m # to identify new Perl dependencies
Install any missing modules
IMPORTANT: Koha 3.6.x uses Template::Toolkit, this must be installed
before the webinstaller can run
sudo apt-get install libtemplate-perl
Koha 3.4.x or later no longer stores items in biblio records so
if you are upgrading from an older version as part of the
upgrade you will need to do the following two steps, they can take a
long time (several hours) to complete for large databases
misc/maintenance/ --run
misc/migration_tools/ -b -r
Uninstall Instructions
1) Stop Services:
$ sudo a2dissite koha
$ sudo rm /etc/apache2/sites-available/koha
$ sudo apache2ctl restart
$ sudo update-rc.d koha-zebra-daemon remove
$ sudo rm /etc/init.d/koha-zebra-daemon
2) Remove Database and Indexes
$ mysql -u<kohauser> -p<kohapassword>
> drop database koha;
# Zebra Indexes
$ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
$ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
3) Remove Koha Install Directories and Configuration Files
Don't forget about any crontab entries
Tested on the following operating environments
- Ubuntu Jaunty Jackalope 9.04
Installer Bug reports
Please log any installer bug reports at
Other Notes
This file is part of Koha
Koha is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
Koha is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with Koha; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.