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 Using the debian.packages file included in the Koha source tree,
  68 run the following:
  69
  70     $ sudo dpkg --set-selections < install_misc/debian.packages
  71
  72 Now start dselect:
  73
  74     $ sudo dselect
  75
  76 Choose [I]nstall and accept packages to be installed (hit return)
  77
  78 (may take a while)
  79
  80 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
  81
  82 1.5 Install Perl dependencies that aren't packaged into Debian Etch
  83 sources
  84
  85 Run the following command:
  86
  87     $ 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
  88
  89 Note: you may need to run CPAN initialization if you've not run cpan
  90 before:
  91
  92     /etc/perl/CPAN/Config.pm initialized.
  93
  94     CPAN is the world-wide archive of perl resources. It consists of about
  95     100 sites that all replicate the same contents all around the globe.
  96     Many countries have at least one CPAN site already. The resources
  97     found on CPAN are easily accessible with the CPAN.pm module. If you
  98     want to use CPAN.pm, you have to configure it properly.
  99
 100     If you do not want to enter a dialog now, you can answer 'no' to this
 101     question and I'll try to autoconfigure. (Note: you can revisit this
 102     dialog anytime later by typing 'o conf init' at the cpan prompt.)
 103
 104     Are you ready for manual configuration? [yes]
 105
 106 When the configuration is completed CPAN will install the Perl modules.
 107
 108 2. Configuration of dependencies
 109
 110 2.1 Update root MySQL password (if dselect didn't do it for you already)
 111
 112     $ sudo mysqladmin password <password>
 113
 114 2.2 Create the Koha database
 115
 116     $ mysqladmin -uroot -p<password> create database <kohadatabasename>
 117     $ mysql -uroot -p<password>
 118
 119     Create the database and user with associated privileges:
 120
 121     Welcome to the MySQL monitor.  Commands end with ; or \g.
 122     Your MySQL connection id is 22
 123     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
 124
 125     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
 126
 127     mysql> create database <kohadatabasename>;
 128     Query OK, 1 row affected (0.00 sec)
 129
 130     mysql> grant all on <kohadatabasename>.* to <kohadatabaseuser> identified by '<kohadatabaseuserpassword>';
 131     Query OK, 0 rows affected (0.00 sec)
 132
 133     mysql> flush privileges;
 134     Query OK, 0 rows affected (0.00 sec)
 135
 136     mysql> quit
 137
 138 3. Run the Koha installer
 139
 140     $ perl Makefile.PL
 141     ( answer questions )
 142     $ make
 143     $ make test
 144     $ sudo make install
 145
 146 4. Configure and start Apache
 147     $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
 148     (note that the path to koha-httpd.conf may be different depending on your
 149     installation choices)
 150
 151 Add the following lines to /etc/apache2/ports.conf:
 152
 153     Listen 80
 154     Listen 8080
 155
 156 Run the following commands:
 157
 158     $ sudo a2enmod rewrite
 159     $ sudo a2ensite koha
 160     $ sudo apache2ctl restart
 161
 162 5. Configure and start Zebra
 163
 164 Note: it's recommended that you daemonize the Zebra process and add it to your
 165 startup profile. For a non-production test/development installation, running
 166 Zebra from the command line can be useful. Pick from the two available options
 167 below, or roll your own :-)
 168
 169 Note: it's also recommended that you create a Koha system user, which you will
 170 have specified during the install process. Alternatively, Zebra can be
 171 configured to run as the root user.
 172
 173 Option 1: run the Zebra processes from the command line:
 174
 175     Zebra Server:
 176     $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
 177     (note that the path to koha-conf.xml may be different depending on your
 178     installation choices)
 179
 180     Note: the user you run Zebra as will be the only user with write permission
 181     on the Zebra index; in development mode, you may wish to use your system
 182     user.
 183
 184     Zebraqueue Daemon:
 185     $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl
 186
 187     Note: if you are running in this mode, you may wish to defer starting the
 188     zebraqueue until you've run the web installer (see below).
 189
 190 Option 2: run the Zebra processes as daemons, and add to startup process:
 191
 192 Note that references to $SCRIPT_DIR refer to the directory where
 193 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
 194
 195     Zebra Server:
 196     $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh  /etc/init.d/koha-zebra-daemon
 197     (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
 198     $ sudo update-rc.d koha-zebra-daemon defaults
 199     ( Note: see man chkconfig(8) on other distros )
 200
 201     $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
 202
 203     Zebraqueue Daemon:
 204     $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh  /etc/init.d/koha-zebraqueue-daemon
 205     $ sudo update-rc.d koha-zebraqueue-daemon defaults
 206     ( Note: see man chkconfig(8) on other distros )
 207
 208     $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
 209
 210 6. Run the Web Installer, populate the database, initial configuration of settings
 211
 212     Point your browser to http://<servername>:8080/
 213
 214     It should redirect you to the Web installer where you can continue the setup.
 215
 216 Uninstall Instructions
 217 =============================
 218 1) Stop Services:
 219    $ sudo a2dissite koha
 220    $ sudo rm /etc/apache2/sites-available/koha
 221    $ sudo apache2ctl restart
 222
 223    $ sudo update-rc.d koha-zebra-daemon remove
 224    $ sudo update-rc.d koha-zebraqueue-daemon remove
 225    $ sudo rm /etc/init.d/koha-zebra-daemon
 226    $ sudo rm /etc/init.d/koha-zebraqueue-daemon
 227
 228 2) Remove Koha Database
 229
 230    # MySQL
 231    $ mysql -u<kohauser> -p<kohapassword>
 232    > drop database koha;
 233
 234    # Zebra Indexes
 235    $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
 236    $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
 237
 238 3) Remove Koha Install Directories
 239
 240 Tested on the following operating environments
 241 ==============================================
 242 - Debian Etch 4.0
 243
 244 Installer Bug reports
 245 =====================
 246 Please send any installer bug reports to jmf AT liblime DOT com
 247
 248 Other Notes
 249 =====================
 250 This file is part of Koha
 251
 252 Koha is free software; you can redistribute it and/or modify it under the
 253 terms of the GNU General Public License as published by the Free Software
 254 Foundation; either version 2 of the License, or (at your option) any later
 255 version.
 256
 257 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
 258 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 259 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 260 You should have received a copy of the GNU General Public License along with
 261 Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
 262 Suite 330, Boston, MA  02111-1307 USA