koha-dev.rot13.org Git - koha_fer/blob - 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 Schedule::At
 114
 115 There is a known but benign error in the test case for Barcode::Code128,
 116 which is required by PDF::Reuse::Barcode.  If this module is not installed,
 117 you can do a forced installation of Barcode::Code128.
 118
 119 Note: you may need to run CPAN initialization if you've not run cpan
 120 before:
 121
 122     /etc/perl/CPAN/Config.pm initialized.
 123
 124     CPAN is the world-wide archive of perl resources. It consists of about
 125     100 sites that all replicate the same contents all around the globe.
 126     Many countries have at least one CPAN site already. The resources
 127     found on CPAN are easily accessible with the CPAN.pm module. If you
 128     want to use CPAN.pm, you have to configure it properly.
 129
 130     If you do not want to enter a dialog now, you can answer 'no' to this
 131     question and I'll try to autoconfigure. (Note: you can revisit this
 132     dialog anytime later by typing 'o conf init' at the cpan prompt.)
 133
 134     Are you ready for manual configuration? [yes]
 135
 136 When the configuration is completed CPAN will install the Perl modules.
 137
 138 2. Configuration of dependencies
 139
 140 2.1 Update root MySQL password (if dselect didn't do it for you already)
 141
 142     $ sudo mysqladmin password <password>
 143
 144 2.2 Create the Koha database
 145
 146     Create the database and user with associated privileges:
 147
 148     $ mysqladmin -uroot -p<password> create <kohadatabasename>
 149     $ mysql -uroot -p<password>
 150
 151     Welcome to the MySQL monitor.  Commands end with ; or \g.
 152     Your MySQL connection id is 22
 153     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
 154
 155     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
 156
 157     mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
 158     Query OK, 0 rows affected (0.00 sec)
 159
 160     mysql> flush privileges;
 161     Query OK, 0 rows affected (0.00 sec)
 162
 163     mysql> quit
 164
 165 2.3 Test your SAX Parser and correct where necessary
 166
 167     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:
 168
 169     $ cd koha
 170     $ misc/sax_parser_print.pl
 171
 172     You should see something like::
 173
 174     XML::LibXML::SAX::Parser=HASH(0x81fe220)
 175
 176     If you're using PurePerl or Expat, you'll need to edit your
 177     ini file, typically located at:
 178
 179     /etc/perl/XML/SAX/ParserDetails.ini
 180
 181 2.4 Install DBD::mysql Perl module
 182
 183 In order to handle UTF-8 correctly, Koha requires at least version 4.004
 184 of the DBD::mysql Perl module. However, Debian Etch has a stable package
 185 only for version 3.0008, so it is necessary to install the module  from CPAN.
 186 DBD::mysql's test suite needs to use a MySQL 'test' DB which doesn't exist
 187 anymore. So there are two options to install DBD::mysql:
 188
 189   (1) install without test suite,
 190   (2) install with test suite requiring a test MySQL DB creation.
 191
 192 2.4.1 Install without test suite
 193
 194 Force install DBD::mysql:
 195
 196     $ sudo cpan
 197     cpan> force install DBD::mysql
 198
 199 2.4.2 Create test database in order to install DBD::mysql
 200
 201 Because of DBD::mysql's test suite, it is necessary to temporarily create a
 202 test database and user:
 203
 204     $ mysql -uroot -p<password>
 205
 206     Create the database and user with associated privileges:
 207
 208     Welcome to the MySQL monitor.  Commands end with ; or \g.
 209     Your MySQL connection id is 22
 210     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
 211
 212     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
 213
 214     mysql> create database test;
 215     Query OK, 1 row affected (0.00 sec)
 216
 217     mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
 218     Query OK, 0 rows affected (0.00 sec)
 219     (test database, user, and password can be different if need be)
 220
 221     mysql> flush privileges;
 222     Query OK, 0 rows affected (0.00 sec)
 223
 224     mysql> quit
 225
 226 Next install DBD::mysql:
 227
 228     $ sudo cpan
 229
 230     cpan> o conf makepl_arg
 231     (get current value of this CPAN parameter)
 232
 233     cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
 234
 235     cpan> install DBD::mysql
 236
 237     cpan> o conf makepl_arg ''
 238
 239     OR
 240
 241     cpan> o conf makepl_arg '<old setting>'
 242
 243     (restore this setting so as to not interfere with future CPAN installs).
 244
 245
 246 Finally, remove the test database:
 247
 248     $ mysql -uroot -p<password>
 249
 250     mysql> drop database test;
 251     Query OK, 1 row affected (0.00 sec)
 252
 253     mysql> exit
 254     Bye
 255
 256 3. Run the Koha installer
 257
 258     $ perl Makefile.PL
 259     ( answer questions )
 260     $ make
 261     $ make test
 262     $ sudo make install
 263
 264 4. Configure and start Apache
 265     $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
 266     (note that the path to koha-httpd.conf may be different depending on your
 267     installation choices)
 268
 269 Add the following lines to /etc/apache2/ports.conf:
 270
 271     Listen 80
 272     Listen 8080
 273
 274 Run the following commands:
 275
 276     $ sudo a2enmod rewrite
 277     $ sudo a2ensite koha
 278     $ sudo apache2ctl restart
 279
 280 5. Configure and start Zebra
 281
 282 Note: it's recommended that you daemonize the Zebra process and add it to your
 283 startup profile. For a non-production test/development installation, running
 284 Zebra from the command line can be useful. Pick from the two available options
 285 below, or roll your own :-)
 286
 287 Note: it's also recommended that you create a Koha system user, which you will
 288 have specified during the install process. Alternatively, Zebra can be
 289 configured to run as the root user.
 290
 291 Option 1: run the Zebra processes from the command line:
 292
 293     Zebra Server:
 294     $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
 295     (note that the path to koha-conf.xml may be different depending on your
 296     installation choices)
 297
 298     Note: the user you run Zebra as will be the only user with write permission
 299     on the Zebra index; in development mode, you may wish to use your system
 300     user.
 301
 302     Zebraqueue Daemon:
 303     $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
 304
 305     Note: if you are running in this mode, you may wish to defer starting the
 306     zebraqueue until you've run the web installer (see below).
 307
 308 Option 2: run the Zebra processes as daemons, and add to startup process:
 309
 310 Note that references to $SCRIPT_DIR refer to the directory where
 311 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
 312
 313     Zebra Server:
 314     $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh  /etc/init.d/koha-zebra-daemon
 315     (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
 316     $ sudo update-rc.d koha-zebra-daemon defaults
 317     ( Note: see man chkconfig(8) on other distros )
 318
 319     $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
 320
 321     Zebraqueue Daemon:
 322     $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh  /etc/init.d/koha-zebraqueue-daemon
 323     $ sudo update-rc.d koha-zebraqueue-daemon defaults
 324     ( Note: see man chkconfig(8) on other distros )
 325
 326     $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
 327
 328 6. Run the Web Installer, populate the database, initial configuration of settings
 329
 330     Point your browser to http://<servername>:8080/
 331
 332     It should redirect you to the Web Installer where you can continue the setup.
 333     You can install the sample data for libraries, patrons, etc. via the Web Installer
 334
 335 7. What next?
 336
 337     Once the installer has completed, you can import and index MARC records from the
 338     command line thusly (Note: you can also use the 'Stage MARC records for import' from
 339     the Tools area of Koha's Staff Client to import a batch of MARC records):
 340
 341     $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
 342       (note: use the correct path to your koha-conf.xml)
 343
 344 7.1 Import:
 345     $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709
 346
 347 7.2 Fast Index:
 348     $ misc/migration-tools/rebuild_zebra.pl -b -w
 349
 350     Once the indexing has completed, you will be able to search for records in your
 351     system. NOTE: if you don't run the Fast Index utility, and you have the zebraqueue
 352     daemon running, the indexin process will happen in the background, but it will be
 353     orders of magnitude slower.
 354
 355     To enable the SRU servers, you'll need to edit your koha-conf.xml and change the
 356     <listen> options to listen on a TCP port; then restart the zebra daemon.
 357
 358 UPGRADE
 359 =======
 360 If you are upgrading from a previous installation of Koha 3, you can
 361 use the following:
 362
 363  perl Makefile.PL --prev-install-log /path/to/koha-install-log
 364  make
 365  make test
 366  sudo make upgrade
 367
 368 Uninstall Instructions
 369 =============================
 370 1) Stop Services:
 371    $ sudo a2dissite koha
 372    $ sudo rm /etc/apache2/sites-available/koha
 373    $ sudo apache2ctl restart
 374
 375    $ sudo update-rc.d koha-zebra-daemon remove
 376    $ sudo update-rc.d koha-zebraqueue-daemon remove
 377    $ sudo rm /etc/init.d/koha-zebra-daemon
 378    $ sudo rm /etc/init.d/koha-zebraqueue-daemon
 379
 380 2) Remove Koha Databases
 381
 382    # MySQL
 383    $ mysql -u<kohauser> -p<kohapassword>
 384    > drop database koha;
 385
 386    # Zebra Indexes
 387    $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
 388    $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
 389
 390 3) Remove Koha Install Directories and Configuration Files
 391
 392 Tested on the following operating environments
 393 ==============================================
 394 - Debian Etch 4.0
 395
 396 Installer Bug reports
 397 =====================
 398 Please send any installer bug reports to jmf AT liblime DOT com
 399
 400 Other Notes
 401 =====================
 402 This file is part of Koha
 403
 404 Koha is free software; you can redistribute it and/or modify it under the
 405 terms of the GNU General Public License as published by the Free Software
 406 Foundation; either version 2 of the License, or (at your option) any later
 407 version.
 408
 409 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
 410 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 411 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 412 You should have received a copy of the GNU General Public License along with
 413 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
 414 Suite 330, Boston, MA  02111-1307 USA