INSTALL.ubuntu

   1 =============================
   2 Installation Guide for Installing Koha on Ubuntu Jaunty (9.04) with MySQL 5
   3 =============================
   4
   5 Copyright (C) 2007, 2008 LibLime (http://liblime.com)
   6
   7 Original author: Joshua Ferraro (jmf AT liblime DOT com)
   8 Modified for Ubuntu by: Chris Nighswonger (cnighswonger AT foundations DOT edu)
   9
  10 Feedback/bug reports: Koha Developer's List:
  11 http://lists.koha.org/mailman/listinfo/koha-devel
  12
  13 This document last modified: 22 June 2009
  14
  15 Installation Instructions
  16 =============================
  17
  18 All commands can be performed as a system user with sudo privileges,
  19 as indicated or by running the command directly as root.
  20
  21 1. Prepare System and Install Dependencies
  22
  23 1.1 Install Ubuntu Jaunty via CD
  24
  25 See http://www.ubuntu.com/getubuntu/download
  26
  27 1.2 Set up your locale
  28
  29 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
  30 This step is VERY IMPORTANT for a UNICODE compliant system. Please
  31 read over the following document carefully:
  32
  33 http://wiki.koha.org/doku.php?id=encodingscratchpad
  34
  35 You can verify your system locale by typing the following command:
  36
  37     $ locale
  38
  39 IMPORTANT:  You _MUST_ follow all the steps outlined there for
  40             Apache2, MySQL 5, etc. BEFORE you install Koha.
  41
  42 1.3 Install the Yaz and Zebra packages
  43
  44 Run the following command to update your system:
  45
  46     $ sudo apt-get update
  47     $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
  48
  49 1.4 Get Koha
  50
  51 1.4.1 Option A: Download Koha via Git (optional)
  52
  53     $ sudo apt-get install git-core git-email
  54     $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
  55     $ cd kohaclone
  56     $ git checkout -b myinstall origin
  57
  58 Note: for more information about Git, please see the Koha Git Usage Guide:
  59
  60     http://wiki.koha.org/doku.php?id=en:development:git_usage
  61
  62 1.4.2 Option B: Download Koha from http://download.koha.org
  63
  64     $ wget http://download.koha.org/koha-3.00.02.tar.gz
  65     ( Note: use the latest stable version)
  66
  67 1.5 Install additional Ubuntu dependencies
  68
  69 IMPORTANT:  You should only use CPAN for Perl dependencies which are NOT
  70             available from the package maintainer. You have been warned!
  71
  72 Using the ubuntu.packages file included in the Koha source tree,
  73 run the following:
  74
  75     $ sudo dpkg --set-selections < install_misc/ubuntu.packages
  76
  77 Now start dselect (you may need to 'sudo apt-get install dselect'):
  78
  79     $ sudo dselect
  80
  81 Choose [I]nstall and accept packages to be installed (hit return)
  82
  83 (may take a while)
  84
  85 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
  86
  87 1.6 Install Perl dependencies that aren't packaged into Ubuntu Jaunty
  88 sources
  89
  90 Run the following command:
  91
  92     $ sudo cpan MARC::Crosswalk::DublinCore GD GD::Barcode::UPCE Email::Date \
  93                 HTML::Scrubber Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle
  94
  95 Note: you may need to run CPAN initialization if you've not run cpan
  96 before:
  97
  98     /etc/perl/CPAN/Config.pm initialized.
  99
 100     CPAN is the world-wide archive of perl resources. It consists of about
 101     100 sites that all replicate the same contents all around the globe.
 102     Many countries have at least one CPAN site already. The resources
 103     found on CPAN are easily accessible with the CPAN.pm module. If you
 104     want to use CPAN.pm, you have to configure it properly.
 105
 106     If you do not want to enter a dialog now, you can answer 'no' to this
 107     question and I'll try to autoconfigure. (Note: you can revisit this
 108     dialog anytime later by typing 'o conf init' at the cpan prompt.)
 109
 110     Are you ready for manual configuration? [yes]
 111
 112 When the configuration is completed CPAN will install the Perl modules.
 113
 114 2. Configuration of dependencies
 115
 116 2.1 Update root MySQL password (if dselect didn't do it for you already)
 117
 118     $ sudo mysqladmin password <password>
 119
 120 2.2 Create the Koha database
 121
 122     Create the database and user with associated privileges:
 123
 124     $ mysqladmin -uroot -p<password> create <kohadatabasename>
 125     $ mysql -uroot -p<password>
 126
 127     Welcome to the MySQL monitor.  Commands end with ; or \g.
 128     Your MySQL connection id is 22
 129     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
 130
 131     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
 132
 133     mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
 134     Query OK, 0 rows affected (0.00 sec)
 135
 136     mysql> flush privileges;
 137     Query OK, 0 rows affected (0.00 sec)
 138
 139     mysql> quit
 140
 141 2.3 Test your SAX Parser and correct where necessary
 142
 143     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:
 144
 145     $ cd koha
 146     $ misc/sax_parser_print.pl
 147
 148     You should see something like::
 149
 150     XML::LibXML::SAX::Parser=HASH(0x81fe220)
 151
 152     If you're using PurePerl or Expat, you'll need to edit your
 153     ini file, typically located at:
 154
 155     /etc/perl/XML/SAX/ParserDetails.ini
 156
 157 2.4 Install DBD::mysql Perl module
 158
 159 In order to handle UTF-8 correctly, Koha requires at least version 4.004
 160 of the DBD::mysql Perl module. However, Debian Etch has a stable package
 161 only for version 3.0008, so it is necessary to install the module  from CPAN.
 162 DBD::mysql's test suite needs to use a MySQL 'test' DB which doesn't exist
 163 anymore. So there are two options to install DBD::mysql:
 164
 165   (1) install without test suite,
 166   (2) install with test suite requiring a test MySQL DB creation.
 167
 168 2.4.1 Install without test suite
 169
 170 Force install DBD::mysql:
 171
 172     $ sudo cpan
 173     cpan> force install DBD::mysql
 174
 175 2.4.2 Create test database in order to install DBD::mysql
 176
 177 Because of DBD::mysql's test suite, it is necessary to temporarily create a
 178 test database and user:
 179
 180     $ mysql -uroot -p<password>
 181
 182     Create the database and user with associated privileges:
 183
 184     Welcome to the MySQL monitor.  Commands end with ; or \g.
 185     Your MySQL connection id is 22
 186     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
 187
 188     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
 189
 190     mysql> create database test;
 191     Query OK, 1 row affected (0.00 sec)
 192
 193     mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
 194     Query OK, 0 rows affected (0.00 sec)
 195     (test database, user, and password can be different if need be)
 196
 197     mysql> flush privileges;
 198     Query OK, 0 rows affected (0.00 sec)
 199
 200     mysql> quit
 201
 202 Next install DBD::mysql:
 203
 204     $ sudo cpan
 205
 206     cpan> o conf makepl_arg
 207     (get current value of this CPAN parameter)
 208
 209     cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
 210
 211     cpan> install DBD::mysql
 212
 213     cpan> o conf makepl_arg ''
 214
 215     OR
 216
 217     cpan> o conf makepl_arg '<old setting>'
 218
 219     (restore this setting so as to not interfere with future CPAN installs).
 220
 221
 222 Finally, remove the test database:
 223
 224     $ mysql -uroot -p<password>
 225
 226     mysql> drop database test;
 227     Query OK, 1 row affected (0.00 sec)
 228
 229     mysql> exit
 230     Bye
 231
 232 3. Run the Koha installer
 233
 234     $ perl Makefile.PL
 235     ( answer questions )
 236     $ make
 237     $ make test
 238     $ sudo make install
 239
 240 4. Configure and start Apache
 241     $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
 242     (note that the path to koha-httpd.conf may be different depending on your
 243     installation choices)
 244
 245 Add the following lines to /etc/apache2/ports.conf:
 246
 247     Listen 80
 248     Listen 8080
 249
 250 If not running named virtual hosts (The default koha installation does not use named virtual hosts.), comment out the following line:
 251
 252     NameVirtualHost *:80
 253
 254 Run the following commands:
 255
 256     $ sudo a2enmod rewrite
 257     $ sudo a2ensite koha
 258     $ sudo apache2ctl restart
 259
 260 Note: you may still see the usual Apache default site if your VirtualHost
 261 configuration isn't correct.  The command "sudo a2dissite default" may be a
 262 quick fix, but may have side-effects.  See the Apache HTTPD manual section on
 263 virtual hosts for full instructions.
 264
 265 5. Configure and start Zebra
 266
 267 Note: it's recommended that you daemonize the Zebra process and add it to your
 268 startup profile. For a non-production test/development installation, running
 269 Zebra from the command line can be useful. Pick from the two available options
 270 below, or roll your own :-)
 271
 272 Note: it's also recommended that you create a Koha system user, which you will
 273 have specified during the install process. Alternatively, Zebra can be
 274 configured to run as the root user.
 275
 276 To add a user do:
 277
 278         $ sudo adduser koha
 279
 280
 281 Option 1: run the Zebra processes from the command line:
 282
 283     Zebra Server:
 284     $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
 285     (note that the path to koha-conf.xml may be different depending on your
 286     installation choices)
 287
 288     Note: the user you run Zebra as will be the only user with write permission
 289     on the Zebra index; in development mode, you may wish to use your system
 290     user.
 291
 292     Zebraqueue Daemon:
 293     $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
 294
 295     Note: if you are running in this mode, you may wish to defer starting the
 296     zebraqueue until you've run the web installer (see below).
 297
 298 Option 2: run the Zebra processes as daemons, and add to startup process:
 299
 300 Note that references to $SCRIPT_DIR refer to the directory where
 301 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
 302
 303     Zebra Server:
 304     $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh  /etc/init.d/koha-zebra-daemon
 305     (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
 306     $ sudo update-rc.d koha-zebra-daemon defaults
 307     ( Note: see man chkconfig(8) on other distros )
 308
 309     $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
 310
 311     Zebraqueue Daemon:
 312     $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh  /etc/init.d/koha-zebraqueue-daemon
 313     $ sudo update-rc.d koha-zebraqueue-daemon defaults
 314     ( Note: see man chkconfig(8) on other distros )
 315
 316     $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
 317
 318 6. Run the Web Installer, populate the database, initial configuration of settings
 319
 320     Point your browser to http://<servername>:8080/
 321
 322     It should redirect you to the Web Installer where you can continue the setup.
 323     You can install the sample data for libraries, patrons, etc. via the Web Installer
 324
 325 7. What next?
 326
 327     Once the installer has completed, you can import and index MARC records from the
 328     command line thusly (Note: you can also use the 'Stage MARC records for import' from
 329     the Tools area of Koha's Staff Client to import a batch of MARC records):
 330
 331     $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
 332       (note: use the correct path to your koha-conf.xml)
 333
 334 7.1 Import:
 335     Bibliographic data in MARC21 format
 336     $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709
 337     Authority data in MARC21 format
 338         $ misc/migration-tools/bulkauthimport.pl -file /path/to/auth.iso2709
 339
 340 7.2 Fast Index:
 341     $ misc/migration-tools/rebuild_zebra.pl -b -w
 342
 343     Once the indexing has completed, you will be able to search for records in your
 344     system. NOTE: if you don't run the Fast Index utility, and you have the index
 345         updates scheduled as per 7.3 the indexing process will happen in the background,
 346         but it will be orders of magnitude slower.
 347
 348 7.3 Schedule regular index updates
 349     run rebuild_zebra.pl -b -a -z as a regular cron job, check misc/cronjobs/crontab.example
 350         for usage examples
 351
 352 7.4 To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
 353     change the <listen> options to listen on a TCP port; then restart the zebra daemon.
 354
 355 UPGRADE
 356 =======
 357 If you are upgrading from a previous installation of Koha 3, you can
 358 use the following:
 359
 360  perl Makefile.PL --prev-install-log /path/to/koha-install-log
 361  make
 362  make test
 363  sudo make upgrade
 364
 365 Uninstall Instructions
 366 =============================
 367 1) Stop Services:
 368    $ sudo a2dissite koha
 369    $ sudo rm /etc/apache2/sites-available/koha
 370    $ sudo apache2ctl restart
 371
 372    $ sudo update-rc.d koha-zebra-daemon remove
 373    $ sudo rm /etc/init.d/koha-zebra-daemon
 374
 375 2) Remove Database and Indexes
 376
 377    # MySQL
 378    $ mysql -u<kohauser> -p<kohapassword>
 379    > drop database koha;
 380
 381    # Zebra Indexes
 382    $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
 383    $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
 384
 385 3) Remove Koha Install Directories and Configuration Files
 386    Don't forget about any crontab entries
 387
 388 Tested on the following operating environments
 389 ==============================================
 390 - Ubuntu Jaunty Jackalope 9.04
 391
 392 Installer Bug reports
 393 =====================
 394 Please log any installer bug reports at http://bugs.koha.org
 395
 396 Other Notes
 397 =====================
 398 This file is part of Koha
 399
 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
 403 version.
 404
 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