Updated INSTALL.opensuse for openSUSE 11.0 Final
[koha.git] / INSTALL.debian
index e08c09b..c0d205d 100644 (file)
@@ -2,11 +2,14 @@
 Installation Guide for Installing Koha on Debian Etch with MySQL 5
 =============================
 
-Copyright (C) 2007, LibLime
+Copyright (C) 2007, 2008 LibLime (http://liblime.com)
 
 Maintainer: Joshua Ferraro (jmf AT liblime DOT com)
-Feedback/bug reports: jmf AT liblime DOT com
-This document last modified: 29 December 2007
+
+Feedback/bug reports: Koha Developer's List:
+http://lists.koha.org/mailman/listinfo/koha-devel
+
+This document last modified: 30 April 2008
 
 Installation Instructions
 =============================
@@ -14,19 +17,24 @@ Installation Instructions
 All commands can be performed as a system user with sudo privileges,
 as indicated or by running the command directly as root.
 
+1. Prepare System and Install Dependencies
+
+1.1 Install Debian Etch via Businesscard CD
+
+See http://www.debian.org/releases/etch/debian-installer/
+
+1.2 Set up your locale
+
 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
 This step is VERY IMPORTANT for a UNICODE compliant system. Please 
 read over the following document carefully:
 
 http://wiki.koha.org/doku.php?id=encodingscratchpad
 
-1. Prepare System and Install Dependencies
-
-1.1 Install Debian Etch via Businesscard CD
-
-See http://www.debian.org/devel/debian-installer/
+IMPORTANT:  You _MUST_ follow all the steps outlined there for
+            Apache2, MySQL 5, etc. BEFORE you install Koha.
 
-1.2 Set up apt sources for Git, Yaz and Zebra packages
+1.3 Set up apt sources for Git, Yaz and Zebra packages
 
 Edit your /etc/apt/sources.list file and add the following:
 
@@ -39,6 +47,7 @@ Edit your /etc/apt/sources.list file and add the following:
 
 Backports packages are signed with a key you can install as follows:
 
+    $ sudo apt-get update
     $ sudo apt-get install debian-backports-keyring
 
 The Index Data packages are signed with a key you can install as follows:
@@ -52,9 +61,9 @@ Run the following command to update your system:
     $ sudo apt-get -t etch-backports install git-core git-email
     $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
 
-1.3 Get Koha
+1.4 Get Koha
 
-1.3.1 Option A: Download Koha via Git (optional)
+1.4.1 Option A: Download Koha via Git (optional)
 
     $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
     $ cd kohaclone
@@ -62,14 +71,17 @@ Run the following command to update your system:
 
 Note: for more information about Git, please see the Koha Git Usage Guide:
 
-       http://wiki.koha.org/doku.php?id=en:development:git_usage
+    http://wiki.koha.org/doku.php?id=en:development:git_usage
 
-1.3.2 Option B: Download Koha from koha.org
+1.4.2 Option B: Download Koha from http://download.koha.org
 
-1.4 Install additional Debian dependencies
+    $ wget http://download.koha.org/koha-3.00.00-beta.tar.gz
+    ( Note: use the latest stable version)
 
-IMPORTANT:  You should only use CPAN for Perl dependencies which are NOT available from the package maintainer.
-            You have been warned!
+1.5 Install additional Debian dependencies
+
+IMPORTANT:  You should only use CPAN for Perl dependencies which are NOT
+            available from the package maintainer. You have been warned!
 
 Using the debian.packages file included in the Koha source tree,
 run the following:
@@ -86,7 +98,7 @@ Choose [I]nstall and accept packages to be installed (hit return)
 
 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
 
-1.5 Install Perl dependencies that aren't packaged into Debian Etch
+1.6 Install Perl dependencies that aren't packaged into Debian Etch
 sources
 
 Run the following command:
@@ -129,7 +141,7 @@ When the configuration is completed CPAN will install the Perl modules.
 
     Create the database and user with associated privileges:
 
-    $ mysqladmin -uroot -p<password> create database <kohadatabasename>
+    $ mysqladmin -uroot -p<password> create <kohadatabasename>
     $ mysql -uroot -p<password>
     
     Welcome to the MySQL monitor.  Commands end with ; or \g.
@@ -146,11 +158,42 @@ When the configuration is completed CPAN will install the Perl modules.
 
     mysql> quit
 
-2.3 Create test database in order to install DBD::mysql
+2.3 Test your SAX Parser and correct where necessary
+
+    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:
+
+    $ cd koha
+    $ misc/sax_parser_print.pl 
+
+    You should see something like::
+
+    XML::LibXML::SAX::Parser=HASH(0x81fe220)
+
+    If you're using PurePerl or Expat, you'll need to edit your
+    ini file, typically located at:
+
+    /etc/perl/XML/SAX/ParserDetails.ini
+
+2.4 Install DBD::mysql Perl module
 
 In order to handle UTF-8 correctly, Koha requires at least version 4.004
-of the DBD::mysql Perl module.  However, Debian Etch has a stable package
+of the DBD::mysql Perl module. However, Debian Etch has a stable package
 only for version 3.0008, so it is necessary to install the module  from CPAN.
+DBD::mysql's test suite needs to use a MySQL 'test' DB which doesn't exist 
+anymore. So there are two options to install DBD::mysql: 
+
+  (1) install without test suite,
+  (2) install with test suite requiring a test MySQL DB creation.
+
+2.4.1 Install without test suite
+
+Force install DBD::mysql:
+
+    $ sudo cpan
+    cpan> force install DBD::mysql
+
+2.4.2 Create test database in order to install DBD::mysql
+
 Because of DBD::mysql's test suite, it is necessary to temporarily create a
 test database and user:
 
@@ -188,7 +231,12 @@ Next install DBD::mysql:
     cpan> install DBD::mysql
 
     cpan> o conf makepl_arg ''
-    (clear this setting to not interface with future CPAN installs).
+
+    OR 
+
+    cpan> o conf makepl_arg '<old setting>'
+
+    (restore this setting so as to not interfere with future CPAN installs).
 
 
 Finally, remove the test database:
@@ -277,7 +325,41 @@ Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
 
     Point your browser to http://<servername>:8080/
 
-    It should redirect you to the Web installer where you can continue the setup.
+    It should redirect you to the Web Installer where you can continue the setup.
+    You can install the sample data for libraries, patrons, etc. via the Web Installer
+
+7. What next?
+
+    Once the installer has completed, you can import and index MARC records from the
+    command line thusly (Note: you can also use the 'Stage MARC records for import' from
+    the Tools area of Koha's Staff Client to import a batch of MARC records):
+
+    $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
+      (note: use the correct path to your koha-conf.xml)
+
+7.1 Import:
+    $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709
+
+7.2 Fast Index:
+    $ misc/migration-tools/rebuild_zebra.pl -b -w
+
+    Once the indexing has completed, you will be able to search for records in your
+    system. NOTE: if you don't run the Fast Index utility, and you have the zebraqueue
+    daemon running, the indexin process will happen in the background, but it will be
+    orders of magnitude slower.
+
+    To enable the SRU servers, you'll need to edit your koha-conf.xml and change the
+    <listen> options to listen on a TCP port; then restart the zebra daemon.
+
+UPGRADE
+=======
+If you are upgrading from a previous installation of Koha 3, you can
+use the following:
+
+ perl Makefile.PL --prev-install-log /path/to/koha-install-log
+ make
+ make test
+ sudo make upgrade
 
 Uninstall Instructions
 =============================