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 1.2 Set up your locale
  27
  28 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
  29 This step is VERY IMPORTANT for a UNICODE compliant system. Please
  30 read over the following document carefully:
  31
  32 http://wiki.koha.org/doku.php?id=encodingscratchpad
  33
  34 IMPORTANT:  You _MUST_ follow all the steps outlined there for
  35             Apache2, MySQL 5, etc. BEFORE you install Koha.
  36
  37 1.3 Set up apt sources for Git, Yaz and Zebra packages
  38
  39 Edit your /etc/apt/sources.list file and add the following:
  40
  41     # Index Data
  42     deb http://ftp.indexdata.dk/debian etch main
  43     deb-src http://ftp.indexdata.dk/debian etch main
  44
  45     # Backports
  46     deb http://www.backports.org/debian etch-backports main contrib non-free
  47
  48 Backports packages are signed with a key you can install as follows:
  49
  50     $ sudo apt-get update
  51     $ sudo apt-get install debian-backports-keyring
  52
  53 The Index Data packages are signed with a key you can install as follows:
  54
  55     $ wget http://ftp.indexdata.dk/debian/indexdata.asc
  56     $ sudo apt-key add indexdata.asc
  57
  58 Run the following command to update your system:
  59
  60     $ sudo apt-get update
  61     $ sudo apt-get -t etch-backports install git-core git-email
  62     $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
  63
  64 1.4 Get Koha
  65
  66 1.4.1 Option A: Download Koha via Git (optional)
  67
  68     $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
  69     $ cd kohaclone
  70     $ git checkout -b myinstall origin
  71
  72 Note: for more information about Git, please see the Koha Git Usage Guide:
  73
  74     http://wiki.koha.org/doku.php?id=en:development:git_usage
  75
  76 1.4.2 Option B: Download Koha from http://download.koha.org
  77
  78     $ wget http://download.koha.org/koha-3.00.00-beta.tar.gz
  79     ( Note: use the latest stable version)
  80
  81 1.5 Install additional Debian dependencies
  82
  83 IMPORTANT:  You should only use CPAN for Perl dependencies which are NOT
  84             available from the package maintainer. You have been warned!
  85
  86 Using the debian.packages file included in the Koha source tree,
  87 run the following:
  88
  89     $ sudo dpkg --set-selections < install_misc/debian.packages
  90
  91 Now start dselect:
  92
  93     $ sudo dselect
  94
  95 Choose [I]nstall and accept packages to be installed (hit return)
  96
  97 (may take a while)
  98
  99 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
 100
 101 1.6 Install Perl dependencies that aren't packaged into Debian Etch
 102 sources
 103
 104 Run the following command:
 105
 106     $ sudo cpan MARC::Record Class::Accessor MARC::Charset MARC::File::XML \
 107                 Net::Z3950::ZOOM HTML::Template::Pro MARC::Crosswalk::DublinCore \
 108                 PDF::Reuse PDF::Reuse::Barcode Data::ICal GD::Barcode::UPCE \
 109                 XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE Schedule::At
 110
 111 There is a known but benign error in the test case for Barcode::Code128,
 112 which is required by PDF::Reuse::Barcode.  If this module is not installed,
 113 you can do a forced installation of Barcode::Code128.
 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 Run the following commands:
 271
 272     $ sudo a2enmod rewrite
 273     $ sudo a2ensite koha
 274     $ sudo apache2ctl restart
 275
 276 5. Configure and start Zebra
 277
 278 Note: it's recommended that you daemonize the Zebra process and add it to your
 279 startup profile. For a non-production test/development installation, running
 280 Zebra from the command line can be useful. Pick from the two available options
 281 below, or roll your own :-)
 282
 283 Note: it's also recommended that you create a Koha system user, which you will
 284 have specified during the install process. Alternatively, Zebra can be
 285 configured to run as the root user.
 286
 287 Option 1: run the Zebra processes from the command line:
 288
 289     Zebra Server:
 290     $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
 291     (note that the path to koha-conf.xml may be different depending on your
 292     installation choices)
 293
 294     Note: the user you run Zebra as will be the only user with write permission
 295     on the Zebra index; in development mode, you may wish to use your system
 296     user.
 297
 298     Zebraqueue Daemon:
 299     $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
 300
 301     Note: if you are running in this mode, you may wish to defer starting the
 302     zebraqueue until you've run the web installer (see below).
 303
 304 Option 2: run the Zebra processes as daemons, and add to startup process:
 305
 306 Note that references to $SCRIPT_DIR refer to the directory where
 307 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
 308
 309     Zebra Server:
 310     $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh  /etc/init.d/koha-zebra-daemon
 311     (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
 312     $ sudo update-rc.d koha-zebra-daemon defaults
 313     ( Note: see man chkconfig(8) on other distros )
 314
 315     $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
 316
 317     Zebraqueue Daemon:
 318     $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh  /etc/init.d/koha-zebraqueue-daemon
 319     $ sudo update-rc.d koha-zebraqueue-daemon defaults
 320     ( Note: see man chkconfig(8) on other distros )
 321
 322     $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
 323
 324 6. Run the Web Installer, populate the database, initial configuration of settings
 325
 326     Point your browser to http://<servername>:8080/
 327
 328     It should redirect you to the Web Installer where you can continue the setup.
 329     You can install the sample data for libraries, patrons, etc. via the Web Installer
 330
 331 7. What next?
 332
 333     Once the installer has completed, you can import and index MARC records from the
 334     command line thusly (Note: you can also use the 'Stage MARC records for import' from
 335     the Tools area of Koha's Staff Client to import a batch of MARC records):
 336
 337     $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
 338       (note: use the correct path to your koha-conf.xml)
 339
 340 7.1 Import:
 341     $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709
 342
 343 7.2 Fast Index:
 344     $ misc/migration-tools/rebuild_zebra.pl -b -w
 345
 346     Once the indexing has completed, you will be able to search for records in your
 347     system. NOTE: if you don't run the Fast Index utility, and you have the zebraqueue
 348     daemon running, the indexin process will happen in the background, but it will be
 349     orders of magnitude slower.
 350
 351     To enable the SRU servers, you'll need to edit your koha-conf.xml and change the
 352     <listen> options to listen on a TCP port; then restart the zebra daemon.
 353
 354 UPGRADE
 355 =======
 356 If you are upgrading from a previous installation of Koha 3, you can
 357 use the following:
 358
 359  perl Makefile.PL --prev-install-log /path/to/koha-install-log
 360  make
 361  make test
 362  sudo make upgrade
 363
 364 Uninstall Instructions
 365 =============================
 366 1) Stop Services:
 367    $ sudo a2dissite koha
 368    $ sudo rm /etc/apache2/sites-available/koha
 369    $ sudo apache2ctl restart
 370
 371    $ sudo update-rc.d koha-zebra-daemon remove
 372    $ sudo update-rc.d koha-zebraqueue-daemon remove
 373    $ sudo rm /etc/init.d/koha-zebra-daemon
 374    $ sudo rm /etc/init.d/koha-zebraqueue-daemon
 375
 376 2) Remove Koha Databases
 377
 378    # MySQL
 379    $ mysql -u<kohauser> -p<kohapassword>
 380    > drop database koha;
 381
 382    # Zebra Indexes
 383    $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
 384    $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
 385
 386 3) Remove Koha Install Directories and Configuration Files
 387
 388 Tested on the following operating environments
 389 ==============================================
 390 - Debian Etch 4.0
 391
 392 Installer Bug reports
 393 =====================
 394 Please send any installer bug reports to jmf AT liblime DOT com
 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