README.debian

   1 =============================
   2 Installation Guide for Installing Koha on Debian Etch with MySQL 5
   3 =============================
   4
   5 Copyright (C) 2007, LibLime
   6
   7 Maintainer: Joshua Ferraro (jmf AT liblime DOT com)
   8 Feedback/bug reports: jmf AT liblime DOT com
   9 This document last modified: 22 December 2007
  10
  11 Installation Instructions
  12 =============================
  13
  14 All commands can be performed as a system user with sudo privileges,
  15 as indicated or by running the command directly as root.
  16
  17 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
  18 This step is VERY IMPORTANT for a UNICODE compliant system. Please
  19 read over the following document carefully:
  20
  21 http://wiki.koha.org/doku.php?id=encodingscratchpad
  22
  23 1. Prepare System and Install Dependencies
  24
  25 1.1 Install Debian Etch via Businesscard CD
  26
  27 See http://www.debian.org/devel/debian-installer/
  28
  29 1.2 Set up apt sources for Git, Yaz and Zebra packages
  30
  31 Edit your /etc/apt/sources.list file and add the following:
  32
  33     # Index Data
  34     deb http://ftp.indexdata.dk/debian etch main
  35     deb-src http://ftp.indexdata.dk/debian etch main
  36
  37     # Backports
  38     deb http://www.backports.org/debian etch-backports main contrib non-free
  39
  40 Backports packages are signed with a key you can install as follows:
  41
  42     $ sudo apt-get install debian-backports-keyring
  43
  44 The Index Data packages are signed with a key you can install as follows:
  45
  46     $ wget http://ftp.indexdata.dk/debian/indexdata.asc
  47     $ sudo apt-key add indexdata.asc
  48
  49 Run the following command to update your system:
  50
  51     $ sudo apt-get update
  52     $ sudo apt-get -t etch-backports install git-core git-email
  53     $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
  54
  55 1.3 Download Koha via Git
  56
  57     $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
  58     $ cd kohaclone
  59     $ git checkout -b myinstall origin
  60
  61 Note: for more information about Git, please see the Koha Git Usage Guide:
  62
  63         http://wiki.koha.org/doku.php?id=en:development:git_usage
  64
  65 1.4 Install additional Debian dependencies
  66
  67 IMPORTANT:  You should only use CPAN for Perl dependencies which are NOT available from the package maintainer.
  68             You have been warned!
  69
  70 Using the debian.packages file included in the Koha source tree,
  71 run the following:
  72
  73     $ sudo dpkg --set-selections < install_misc/debian.packages
  74
  75 Now start dselect:
  76
  77     $ sudo dselect
  78
  79 Choose [I]nstall and accept packages to be installed (hit return)
  80
  81 (may take a while)
  82
  83 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
  84
  85 1.5 Install Perl dependencies that aren't packaged into Debian Etch
  86 sources
  87
  88 Run the following command:
  89
  90     $ sudo cpan MARC::Record Class::Accessor MARC::Charset MARC::File::XML Net::Z3950::ZOOM HTML::Template::Pro MARC::Crosswalk::DublinCore PDF::Reuse PDF::Reuse::Barcode Data::ICal GD::Barcode::UPCE XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE Schedule::At
  91
  92 Note: you may need to run CPAN initialization if you've not run cpan
  93 before:
  94
  95     /etc/perl/CPAN/Config.pm initialized.
  96
  97     CPAN is the world-wide archive of perl resources. It consists of about
  98     100 sites that all replicate the same contents all around the globe.
  99     Many countries have at least one CPAN site already. The resources
 100     found on CPAN are easily accessible with the CPAN.pm module. If you
 101     want to use CPAN.pm, you have to configure it properly.
 102
 103     If you do not want to enter a dialog now, you can answer 'no' to this
 104     question and I'll try to autoconfigure. (Note: you can revisit this
 105     dialog anytime later by typing 'o conf init' at the cpan prompt.)
 106
 107     Are you ready for manual configuration? [yes]
 108
 109 When the configuration is completed CPAN will install the Perl modules.
 110
 111 2. Configuration of dependencies
 112
 113 2.1 Update root MySQL password (if dselect didn't do it for you already)
 114
 115     $ sudo mysqladmin password <password>
 116
 117 2.2 Create the Koha database
 118
 119     $ mysqladmin -uroot -p<password> create database <kohadatabasename>
 120     $ mysql -uroot -p<password>
 121
 122     Create the database and user with associated privileges:
 123
 124     Welcome to the MySQL monitor.  Commands end with ; or \g.
 125     Your MySQL connection id is 22
 126     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
 127
 128     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
 129
 130     mysql> create database <kohadatabasename>;
 131     Query OK, 1 row affected (0.00 sec)
 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 3. Run the Koha installer
 142
 143     $ perl Makefile.PL
 144     ( answer questions )
 145     $ make
 146     $ make test
 147     $ sudo make install
 148
 149 4. Configure and start Apache
 150     $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
 151     (note that the path to koha-httpd.conf may be different depending on your
 152     installation choices)
 153
 154 Add the following lines to /etc/apache2/ports.conf:
 155
 156     Listen 80
 157     Listen 8080
 158
 159 Run the following commands:
 160
 161     $ sudo a2enmod rewrite
 162     $ sudo a2ensite koha
 163     $ sudo apache2ctl restart
 164
 165 5. Configure and start Zebra
 166
 167 Note: it's recommended that you daemonize the Zebra process and add it to your
 168 startup profile. For a non-production test/development installation, running
 169 Zebra from the command line can be useful. Pick from the two available options
 170 below, or roll your own :-)
 171
 172 Note: it's also recommended that you create a Koha system user, which you will
 173 have specified during the install process. Alternatively, Zebra can be
 174 configured to run as the root user.
 175
 176 Option 1: run the Zebra processes from the command line:
 177
 178     Zebra Server:
 179     $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
 180     (note that the path to koha-conf.xml may be different depending on your
 181     installation choices)
 182
 183     Note: the user you run Zebra as will be the only user with write permission
 184     on the Zebra index; in development mode, you may wish to use your system
 185     user.
 186
 187     Zebraqueue Daemon:
 188     $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
 189
 190     Note: if you are running in this mode, you may wish to defer starting the
 191     zebraqueue until you've run the web installer (see below).
 192
 193 Option 2: run the Zebra processes as daemons, and add to startup process:
 194
 195 Note that references to $SCRIPT_DIR refer to the directory where
 196 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
 197
 198     Zebra Server:
 199     $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh  /etc/init.d/koha-zebra-daemon
 200     (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
 201     $ sudo update-rc.d koha-zebra-daemon defaults
 202     ( Note: see man chkconfig(8) on other distros )
 203
 204     $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
 205
 206     Zebraqueue Daemon:
 207     $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh  /etc/init.d/koha-zebraqueue-daemon
 208     $ sudo update-rc.d koha-zebraqueue-daemon defaults
 209     ( Note: see man chkconfig(8) on other distros )
 210
 211     $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
 212
 213 6. Run the Web Installer, populate the database, initial configuration of settings
 214
 215     Point your browser to http://<servername>:8080/
 216
 217     It should redirect you to the Web installer where you can continue the setup.
 218
 219 Uninstall Instructions
 220 =============================
 221 1) Stop Services:
 222    $ sudo a2dissite koha
 223    $ sudo rm /etc/apache2/sites-available/koha
 224    $ sudo apache2ctl restart
 225
 226    $ sudo update-rc.d koha-zebra-daemon remove
 227    $ sudo update-rc.d koha-zebraqueue-daemon remove
 228    $ sudo rm /etc/init.d/koha-zebra-daemon
 229    $ sudo rm /etc/init.d/koha-zebraqueue-daemon
 230
 231 2) Remove Koha Database
 232
 233    # MySQL
 234    $ mysql -u<kohauser> -p<kohapassword>
 235    > drop database koha;
 236
 237    # Zebra Indexes
 238    $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
 239    $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
 240
 241 3) Remove Koha Install Directories
 242
 243 Tested on the following operating environments
 244 ==============================================
 245 - Debian Etch 4.0
 246
 247 Installer Bug reports
 248 =====================
 249 Please send any installer bug reports to jmf AT liblime DOT com
 250
 251 Other Notes
 252 =====================
 253 This file is part of Koha
 254
 255 Koha is free software; you can redistribute it and/or modify it under the
 256 terms of the GNU General Public License as published by the Free Software
 257 Foundation; either version 2 of the License, or (at your option) any later
 258 version.
 259
 260 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
 261 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 262 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 263 You should have received a copy of the GNU General Public License along with
 264 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
 265 Suite 330, Boston, MA  02111-1307 USA