INSTALL.debian

   1 =============================
   2 Installation Guide for Installing Koha on Debian Etch with MySQL 5
   3 =============================
   4
   5 Copyright (C) 2007, 2008 LibLime (http://liblime.com)
   6
   7 Maintainer: Joshua Ferraro (jmf AT liblime DOT com)
   8
   9 Feedback/bug reports: Koha Developer's List:
  10 http://lists.koha.org/mailman/listinfo/koha-devel
  11
  12 This document last modified: 30 April 2008
  13
  14 Installation Instructions
  15 =============================
  16
  17 All commands can be performed as a system user with sudo privileges,
  18 as indicated or by running the command directly as root.
  19
  20 1. Prepare System and Install Dependencies
  21
  22 1.1 Install Debian Etch via Businesscard CD
  23
  24 See http://www.debian.org/releases/etch/debian-installer/
  25
  26 WARNING: use Perl 5.8 (a library Koha depends on,
  27 MARC::File::XML may not work with Perl 5.10, see:
  28 http://bugs.koha.org/cgi-bin/bugzilla/show_bug.cgi?id=2309),
  29
  30 1.2 Set up your locale
  31
  32 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
  33 This step is VERY IMPORTANT for a UNICODE compliant system. Please
  34 read over the following document carefully:
  35
  36 http://wiki.koha.org/doku.php?id=encodingscratchpad
  37
  38 IMPORTANT:  You _MUST_ follow all the steps outlined there for
  39             Apache2, MySQL 5, etc. BEFORE you install Koha.
  40
  41 1.3 Set up apt sources for Git, Yaz and Zebra packages
  42
  43 Edit your /etc/apt/sources.list file and add the following:
  44
  45     # Index Data
  46     deb http://ftp.indexdata.dk/debian etch main
  47     deb-src http://ftp.indexdata.dk/debian etch main
  48
  49     # Backports
  50     deb http://www.backports.org/debian etch-backports main contrib non-free
  51
  52 Backports packages are signed with a key you can install as follows:
  53
  54     $ sudo apt-get update
  55     $ sudo apt-get install debian-backports-keyring
  56
  57 The Index Data packages are signed with a key you can install as follows:
  58
  59     $ wget http://ftp.indexdata.dk/debian/indexdata.asc
  60     $ sudo apt-key add indexdata.asc
  61
  62 Run the following command to update your system:
  63
  64     $ sudo apt-get update
  65     $ sudo apt-get -t etch-backports install git-core git-email
  66     $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
  67
  68 1.4 Get Koha
  69
  70 1.4.1 Option A: Download Koha via Git (optional)
  71
  72     $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
  73     $ cd kohaclone
  74     $ git checkout -b myinstall origin
  75
  76 Note: for more information about Git, please see the Koha Git Usage Guide:
  77
  78     http://wiki.koha.org/doku.php?id=en:development:git_usage
  79
  80 1.4.2 Option B: Download Koha from http://download.koha.org
  81
  82     $ wget http://download.koha.org/koha-3.00.00-beta.tar.gz
  83     ( Note: use the latest stable version)
  84
  85 1.5 Install additional Debian dependencies
  86
  87 IMPORTANT:  You should only use CPAN for Perl dependencies which are NOT
  88             available from the package maintainer. You have been warned!
  89
  90 Using the debian.packages file included in the Koha source tree,
  91 run the following:
  92
  93     $ sudo dpkg --set-selections < install_misc/debian.packages
  94
  95 Now start dselect:
  96
  97     $ sudo dselect
  98
  99 Choose [I]nstall and accept packages to be installed (hit return)
 100
 101 (may take a while)
 102
 103 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
 104
 105 1.6 Install Perl dependencies that aren't packaged into Debian Etch
 106 sources
 107
 108 Run the following command:
 109
 110     $ sudo cpan MARC::Record Class::Accessor MARC::Charset MARC::File::XML \
 111                 Net::Z3950::ZOOM HTML::Template::Pro MARC::Crosswalk::DublinCore \
 112                 PDF::Reuse PDF::Reuse::Barcode Data::ICal GD::Barcode::UPCE \
 113                 XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE \
 114                 Schedule::At DBD::SQLite GD SMS::Send HTTP::OAI
 115
 116
 117   WARNINGS:
 118   1.6.1 A Perl library Koha depends on, MARC::File::XML may not work with Perl
 119     5.10, see: http://bugs.koha.org/cgi-bin/bugzilla/show_bug.cgi?id=2309),
 120
 121   1.6.2 Recent versions of CGI::Session have caused some issues for users;
 122   as of this release date, we suggest downloading the CGI::Session::Serialize::yaml
 123   tarball direct from CPAN and install it directly rather than using the cpan command
 124
 125   1.6.3 There is a known but benign error in the test case for Barcode::Code128,
 126   which is required by PDF::Reuse::Barcode.  If this module is not installed,
 127   you can do a forced installation of Barcode::Code128.
 128
 129 Note: you may need to run CPAN initialization if you've not run cpan
 130 before:
 131
 132     /etc/perl/CPAN/Config.pm initialized.
 133
 134     CPAN is the world-wide archive of perl resources. It consists of about
 135     100 sites that all replicate the same contents all around the globe.
 136     Many countries have at least one CPAN site already. The resources
 137     found on CPAN are easily accessible with the CPAN.pm module. If you
 138     want to use CPAN.pm, you have to configure it properly.
 139
 140     If you do not want to enter a dialog now, you can answer 'no' to this
 141     question and I'll try to autoconfigure. (Note: you can revisit this
 142     dialog anytime later by typing 'o conf init' at the cpan prompt.)
 143
 144     Are you ready for manual configuration? [yes]
 145
 146 When the configuration is completed CPAN will install the Perl modules.
 147
 148 2. Configuration of dependencies
 149
 150 2.1 Update root MySQL password (if dselect didn't do it for you already)
 151
 152     $ sudo mysqladmin password <password>
 153
 154 2.2 Create the Koha database
 155
 156     Create the database and user with associated privileges:
 157
 158     $ mysqladmin -uroot -p<password> create <kohadatabasename>
 159     $ mysql -uroot -p<password>
 160
 161     Welcome to the MySQL monitor.  Commands end with ; or \g.
 162     Your MySQL connection id is 22
 163     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
 164
 165     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
 166
 167     mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
 168     Query OK, 0 rows affected (0.00 sec)
 169
 170     mysql> flush privileges;
 171     Query OK, 0 rows affected (0.00 sec)
 172
 173     mysql> quit
 174
 175 2.3 Test your SAX Parser and correct where necessary
 176
 177     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:
 178
 179     $ cd koha
 180     $ misc/sax_parser_print.pl
 181
 182     You should see something like::
 183
 184     XML::LibXML::SAX::Parser=HASH(0x81fe220)
 185
 186     If you're using PurePerl or Expat, you'll need to edit your
 187     ini file, typically located at:
 188
 189     /etc/perl/XML/SAX/ParserDetails.ini
 190
 191 2.4 Install DBD::mysql Perl module
 192
 193 In order to handle UTF-8 correctly, Koha requires at least version 4.004
 194 of the DBD::mysql Perl module. However, Debian Etch has a stable package
 195 only for version 3.0008, so it is necessary to install the module  from CPAN.
 196 DBD::mysql's test suite needs to use a MySQL 'test' DB which doesn't exist
 197 anymore. So there are two options to install DBD::mysql:
 198
 199   (1) install without test suite,
 200   (2) install with test suite requiring a test MySQL DB creation.
 201
 202 2.4.1 Install without test suite
 203
 204 Force install DBD::mysql:
 205
 206     $ sudo cpan
 207     cpan> force install DBD::mysql
 208
 209 2.4.2 Create test database in order to install DBD::mysql
 210
 211 Because of DBD::mysql's test suite, it is necessary to temporarily create a
 212 test database and user:
 213
 214     $ mysql -uroot -p<password>
 215
 216     Create the database and user with associated privileges:
 217
 218     Welcome to the MySQL monitor.  Commands end with ; or \g.
 219     Your MySQL connection id is 22
 220     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
 221
 222     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
 223
 224     mysql> create database test;
 225     Query OK, 1 row affected (0.00 sec)
 226
 227     mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
 228     Query OK, 0 rows affected (0.00 sec)
 229     (test database, user, and password can be different if need be)
 230
 231     mysql> flush privileges;
 232     Query OK, 0 rows affected (0.00 sec)
 233
 234     mysql> quit
 235
 236 Next install DBD::mysql:
 237
 238     $ sudo cpan
 239
 240     cpan> o conf makepl_arg
 241     (get current value of this CPAN parameter)
 242
 243     cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
 244
 245     cpan> install DBD::mysql
 246
 247     cpan> o conf makepl_arg ''
 248
 249     OR
 250
 251     cpan> o conf makepl_arg '<old setting>'
 252
 253     (restore this setting so as to not interfere with future CPAN installs).
 254
 255
 256 Finally, remove the test database:
 257
 258     $ mysql -uroot -p<password>
 259
 260     mysql> drop database test;
 261     Query OK, 1 row affected (0.00 sec)
 262
 263     mysql> exit
 264     Bye
 265
 266 3. Run the Koha installer
 267
 268     $ perl Makefile.PL
 269     ( answer questions )
 270     $ make
 271     $ make test
 272     $ sudo make install  #If doing a -dev install, skip the sudo!
 273
 274 4. Configure and start Apache
 275     $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
 276     (note that the path to koha-httpd.conf may be different depending on your
 277     installation choices)
 278
 279 Add the following lines to /etc/apache2/ports.conf:
 280
 281     Listen 80
 282         Listen 8080
 283
 284 (Note: It may be productive to use different DNS entries and NamedVirtualHosts
 285 directives in Apache to separate the staff and OPAC clients, to eliminate a
 286 cross-client authentication nuisance, but it will work fine like this.)
 287
 288 Run the following commands:
 289
 290     $ sudo a2enmod rewrite
 291     $ sudo a2ensite koha
 292     $ sudo apache2ctl restart
 293
 294 Note: you may still see the usual Apache default site if your VirtualHost
 295 configuration isn't correct.  The command "sudo a2dissite default" may be a
 296 quick fix, but may have side-effects.  See the Apache HTTPD manual section on
 297 virtual hosts for full instructions.
 298
 299 5. Configure and start Zebra
 300
 301 Note: it's recommended that you daemonize the Zebra process and add it to your
 302 startup profile. For a non-production test/development installation, running
 303 Zebra from the command line can be useful.  Otherwise you will want zebrasrv
 304 running when Apache/Koha is.
 305
 306 Note: it's also recommended that you create a Koha system user, which you will
 307 have specified during the install process. Alternatively, Zebra can be
 308 configured to run as the root user.
 309
 310 Option 1: run the Zebra processes from the command line:
 311
 312     Zebra Server:
 313     $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
 314     (note that the path to koha-conf.xml may be different depending on your
 315     installation choices)
 316
 317     Note: the user you run Zebra as will be the only user with write permission
 318     on the Zebra index; in development mode, you may wish to use your system
 319     user.
 320
 321     Zebraqueue Daemon (not recommended -- use rebuild_zebra in crontab instead):
 322     $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
 323
 324     Note: if you are running in this mode, you may wish to defer starting the
 325     zebraqueue until you've run the web installer (see below).
 326
 327 Option 2: run the Zebra processes as daemons, and add to startup process:
 328
 329 Note that references to $SCRIPT_DIR refer to the directory where
 330 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
 331
 332     Zebra Server:
 333     $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh  /etc/init.d/koha-zebra-daemon
 334     (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
 335     $ sudo update-rc.d koha-zebra-daemon defaults
 336     ( Note: see man chkconfig(8) on other distros )
 337
 338     $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
 339
 340     Zebraqueue Daemon (not recommended -- use rebuild_zebra in crontab instead):
 341     $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh  /etc/init.d/koha-zebraqueue-daemon
 342     $ sudo update-rc.d koha-zebraqueue-daemon defaults
 343     ( Note: see man chkconfig(8) on other distros )
 344
 345     $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
 346
 347 6. Run the Web Installer, populate the database, initial configuration of settings
 348
 349     Point your browser to http://<servername>:8080/
 350
 351     It should redirect you to the Web Installer where you can continue the setup.
 352     You can install the sample data for libraries, patrons, etc. via the Web Installer
 353
 354 7. What next?
 355
 356     Once the installer has completed, you can import and index MARC records from the
 357     command line thusly (Note: you can also use the 'Stage MARC records for import' from
 358     the Tools area of Koha's Staff Client to import a batch of MARC records):
 359
 360     $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
 361       (note: use the correct path to your koha-conf.xml)
 362
 363 7.0 Schedule crontab jobs
 364     Do you want Koha to:
 365         send mail?
 366         automatically index added records?
 367         generate overdue or advance notices?
 368         mark items lost after they are long overdue?
 369         assess fines?
 370
 371     All these and other regularly scheduled background tasks are handled by crontab.
 372     You need to examine the example crontab file, edit a copy to your liking, and schedule it.
 373
 374     $ crontab -l           # just check if you have any other jobs already scheduled
 375     $ cp ./misc/cronjobs/crontab.example my_crontab
 376     $ vi my_crontab        # select jobs or adjust times.
 377     $                      # If you had already scheduled lines, add them at the bottom.
 378     $ crontab my_crontab   # This overwrites your scheduled jobs with the new ones.
 379
 380     If you want to check to confirm, you can run crontab -l again.
 381
 382 7.1 Import:
 383     Bibliographic data in MARC21 format
 384     $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709
 385     Authority data in MARC21 format
 386         $ misc/migration-tools/bulkauthimport.pl -file /path/to/auth.iso2709
 387
 388 7.2 Fast Index:
 389     $ misc/migration-tools/rebuild_zebra.pl -b -w
 390
 391     Once the indexing has completed, you will be able to search for records in your
 392     system. NOTE: if you don't run the Fast Index utility, and you have the index
 393         updates scheduled as per 7.3 the indexing process will happen in the background,
 394         but it will be orders of magnitude slower.
 395
 396 7.3 Schedule regular index updates
 397     run rebuild_zebra.pl -b -a -z as a regular cron job, check misc/cronjobs/crontab.example
 398         for usage examples.  Do not schedule rebuild_zebra AND run zebraqueue.  Pick one or the other.
 399     See 7.0 above.
 400
 401 7.4 To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
 402     change the <listen> options to listen on a TCP port; then restart the zebra daemon.
 403
 404 UPGRADE
 405 =======
 406 If you are upgrading from a previous installation of Koha 3, you can
 407 use the following:
 408
 409  perl Makefile.PL --prev-install-log /path/to/koha-install-log
 410  make
 411  make test
 412  sudo make upgrade
 413
 414 Uninstall Instructions
 415 =============================
 416 1) Stop Services:
 417    $ sudo a2dissite koha
 418    $ sudo rm /etc/apache2/sites-available/koha
 419    $ sudo apache2ctl restart
 420
 421    $ sudo update-rc.d koha-zebra-daemon remove
 422    $ sudo rm /etc/init.d/koha-zebra-daemon
 423
 424 2) Remove Database and Indexes
 425
 426    # MySQL
 427    $ mysql -u<kohauser> -p<kohapassword>
 428    > drop database koha;
 429
 430    # Zebra Indexes
 431    $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
 432    $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
 433
 434 3) Remove Koha Install Directories and Configuration Files
 435    Don't forget about any crontab entries
 436
 437 Tested on the following operating environments
 438 ==============================================
 439 - Debian Etch 4.0
 440
 441 Installer Bug reports
 442 =====================
 443 Please send any installer bug reports to jmf AT liblime DOT com
 444
 445 Other Notes
 446 =====================
 447 This file is part of Koha
 448
 449 Koha is free software; you can redistribute it and/or modify it under the
 450 terms of the GNU General Public License as published by the Free Software
 451 Foundation; either version 2 of the License, or (at your option) any later
 452 version.
 453
 454 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
 455 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 456 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 457 You should have received a copy of the GNU General Public License along with
 458 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
 459 Suite 330, Boston, MA  02111-1307 USA