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