X-Git-Url: http://koha-dev.rot13.org:8081/gitweb/?a=blobdiff_plain;f=INSTALL.debian;h=cb38921d77213b07f09cc942a239f88b6672834c;hb=a115a474c1613a4bcd15cbd7f607d4cf5a92132d;hp=92e6ef5a586fac1cbb6df7a3bba541214cccd7d3;hpb=33bc56febda55e78d0bfa7a98cef7b6c31802a18;p=koha_gimpoz diff --git a/INSTALL.debian b/INSTALL.debian index 92e6ef5a58..cb38921d77 100644 --- a/INSTALL.debian +++ b/INSTALL.debian @@ -1,12 +1,13 @@ ============================= -Installation Guide for Installing Koha on Debian Etch with MySQL 5 +Installation Guide for Installing Koha on Debian Lenny with MySQL 5 ============================= -Copyright (C) 2007, LibLime +Some parts copyright 2010 Chris Nighswonger -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-community.org/cgi-bin/mailman/listinfo/koha-devel + +This document last modified: 19 May 2010 Installation Instructions ============================= @@ -16,98 +17,61 @@ 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.1 Install Debian Lenny via Businesscard CD -IMPORTANT: You _MUST_ follow all the steps outlined there for - Apache2, MySQL 5, etc. BEFORE you install Koha. +See http://www.debian.org/releases/lenny/debian-installer/ -1.3 Set up apt sources for Git, Yaz and Zebra packages +1.3 Set up Indexdata apt sources for Yaz and Zebra packages Edit your /etc/apt/sources.list file and add the following: # Index Data - deb http://ftp.indexdata.dk/debian etch main - deb-src http://ftp.indexdata.dk/debian etch main - - # Backports - deb http://www.backports.org/debian etch-backports main contrib non-free - -Backports packages are signed with a key you can install as follows: - - $ sudo apt-get update - $ sudo apt-get install debian-backports-keyring + deb http://ftp.indexdata.dk/debian lenny main + deb-src http://ftp.indexdata.dk/debian lenny main The Index Data packages are signed with a key you can install as follows: $ wget http://ftp.indexdata.dk/debian/indexdata.asc $ sudo apt-key add indexdata.asc -Run the following command to update your system: - - $ sudo apt-get update - $ sudo apt-get -t etch-backports install git-core git-email - $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc - 1.4 Get Koha 1.4.1 Option A: Download Koha via Git (optional) - $ git clone git://git.koha.org/pub/scm/koha.git kohaclone + $ sudo apt-get install git-core git-email + $ git clone git://git.koha-community.org/pub/scm/koha.git kohaclone $ cd kohaclone $ git checkout -b myinstall origin 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-community.org/wiki/Version_Control_Using_Git + +1.4.2 Option B: Download Koha from http://download.koha-community.org -1.4.2 Option B: Download Koha from http://download.koha.org +Find the latest Koha stable version on http://download.koha-community.org +and get it: - $ wget http://download.koha.org/koha-3.00.00-alpha.tar.gz - ( Note: use the latest stable version) + $ wget found on download.koha-community.org 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: - - $ sudo dpkg --set-selections < install_misc/debian.packages - -Now start dselect: +Run shell script installing all necessary Debian packages, MySQL Server, +Zebra and all Debian packaged Perl module required by Koha: - $ sudo dselect + $ sudo install_misc/apt-get-debian-lenny.sh -Choose [I]nstall and accept packages to be installed (hit return) - -(may take a while) - -Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed. - -1.6 Install Perl dependencies that aren't packaged into Debian Etch +1.6 Install Perl dependencies that aren't packaged into Debian Lenny sources Run the following command: - $ 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 - -There is a known but benign error in the test case for Barcode::Code128, -which is required by PDF::Reuse::Barcode. If this module is not installed, -you can do a forced installation of Barcode::Code128. + $ sudo cpan Algorithm::CheckDigits SMS::Send HTTP::OAI IPC::Cmd \ + Memoize::Memcached PDF::API2::Simple PDF::Table Storable Test::More \ + Locale::Currency::Format Note: you may need to run CPAN initialization if you've not run cpan before: @@ -143,7 +107,7 @@ When the configuration is completed CPAN will install the Perl modules. Welcome to the MySQL monitor. Commands end with ; or \g. Your MySQL connection id is 22 - Server version: 5.0.32-Debian_7etch3-log Debian etch distribution + Server version: 5.0.51a-24 (Debian) Type 'help;' or '\h' for help. Type '\c' to clear the buffer. @@ -157,7 +121,9 @@ When the configuration is completed CPAN will install the Perl modules. 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: +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 @@ -171,65 +137,6 @@ When the configuration is completed CPAN will install the Perl modules. /etc/perl/XML/SAX/ParserDetails.ini -2.4 Create test database in order to install DBD::mysql - -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 -only for version 3.0008, so it is necessary to install the module from CPAN. -Because of DBD::mysql's test suite, it is necessary to temporarily create a -test database and user: - - $ mysql -uroot -p - - Create the database and user with associated privileges: - - Welcome to the MySQL monitor. Commands end with ; or \g. - Your MySQL connection id is 22 - Server version: 5.0.32-Debian_7etch3-log Debian etch distribution - - Type 'help;' or '\h' for help. Type '\c' to clear the buffer. - - mysql> create database test; - Query OK, 1 row affected (0.00 sec) - - mysql> grant all on test.* to 'test'@'localhost' identified by 'test'; - Query OK, 0 rows affected (0.00 sec) - (test database, user, and password can be different if need be) - - mysql> flush privileges; - Query OK, 0 rows affected (0.00 sec) - - mysql> quit - -Next install DBD::mysql: - - $ sudo cpan - - cpan> o conf makepl_arg - (get current value of this CPAN parameter) - - cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test" - - cpan> install DBD::mysql - - cpan> o conf makepl_arg '' - - OR - - cpan> o conf makepl_arg '' - - (restore this setting so as to not interfere with future CPAN installs). - - -Finally, remove the test database: - - $ mysql -uroot -p - - mysql> drop database test; - Query OK, 1 row affected (0.00 sec) - - mysql> exit - Bye 3. Run the Koha installer @@ -255,6 +162,11 @@ Run the following commands: $ sudo a2ensite koha $ sudo apache2ctl restart +Note: you may still see the usual Apache default site if your VirtualHost +configuration isn't correct. The command "sudo a2dissite default" may be a +quick fix, but may have side-effects. See the Apache HTTPD manual section on +virtual hosts for full instructions. + 5. Configure and start Zebra Note: it's recommended that you daemonize the Zebra process and add it to your @@ -268,40 +180,51 @@ configured to run as the root user. Option 1: run the Zebra processes from the command line: - Zebra Server: +1.1 Zebra Search Server + +This process send responses to search requests sent by Koha or +Z39.50/SRU/SRW clients. + $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml (note that the path to koha-conf.xml may be different depending on your installation choices) - Note: the user you run Zebra as will be the only user with write permission - on the Zebra index; in development mode, you may wish to use your system - user. +Note: the user you run Zebra as will be the only user with write permission + on the Zebra index; in development mode, you may wish to use your + system user. - Zebraqueue Daemon: - $ sudo -u ${KOHA_USER} misc/bin/zebraqueue_daemon.pl +1.2 Zebra Indexer - Note: if you are running in this mode, you may wish to defer starting the - zebraqueue until you've run the web installer (see below). +Added/updated/deleted records in Koha MySQL database must be indexed +into Zebra. A specific script must be launched each time a bibliographic +or an authority record is edited. -Option 2: run the Zebra processes as daemons, and add to startup process: + $ sudo -u ${KOHA_USER} misc/migration_tools/rebuild_zebra -z -b -a + NOTE: This script should be run as the kohauser (the default is 'koha'). + +Option 2: run automatically Zebra process as a daemon: Note that references to $SCRIPT_DIR refer to the directory where Koha's command-line scripts are installed, e.g., /usr/share/koha/bin. - Zebra Server: +1.1 Zebra Search Server + $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install) $ sudo update-rc.d koha-zebra-daemon defaults ( Note: see man chkconfig(8) on other distros ) - + $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start - Zebraqueue Daemon: - $ sudo ln -s ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh /etc/init.d/koha-zebraqueue-daemon - $ sudo update-rc.d koha-zebraqueue-daemon defaults - ( Note: see man chkconfig(8) on other distros ) +1.2 Zebra Indexer + +Add an entry in Koha user crontab to scheduled added/updated/deleted records +indexing by Zebra with this command: - $ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start + /misc/migration_tools/rebuild_zebra -z -b -a + +See check misc/cronjobs/crontab.example for usage examples. +NOTE: This job should be setup under the kohauser (the default is 'koha'). 6. Run the Web Installer, populate the database, initial configuration of settings @@ -320,18 +243,28 @@ Koha's command-line scripts are installed, e.g., /usr/share/koha/bin. (note: use the correct path to your koha-conf.xml) 7.1 Import: - $ misc/migration-tools/bulkmarcimport.pl -file /path/to/marc.iso2709 + +Bibliographic data in MARC21 format + + $ misc/migration_tools/bulkmarcimport.pl -file /path/to/marc.iso2709 + +Authority data in MARC21 format + + $ misc/migration_tools/bulkmarcimport.pl -a -file /path/to/auth.iso2709 7.2 Fast Index: - $ misc/migration-tools/rebuild_zebra.pl -b -w + $ 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: This script should be run as the kohauser (the default is 'koha'). - 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. +7.3 Schedule regular index updates + You need to run rebuild_zebra.pl -b -a -z as a regular cron job in orde to pick up new bibs + and items as you add them. Check misc/cronjobs/crontab.example for usage examples. See 7.0 above. + NOTE: This job should be setup under the kohauser (the default is 'koha'). - To enable the SRU servers, you'll need to edit your koha-conf.xml and change the - options to listen on a TCP port; then restart the zebra daemon. +7.4 To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and + change the options to listen on a TCP port; then restart the zebra daemon. UPGRADE ======= @@ -351,11 +284,9 @@ Uninstall Instructions $ sudo apache2ctl restart $ sudo update-rc.d koha-zebra-daemon remove - $ sudo update-rc.d koha-zebraqueue-daemon remove $ sudo rm /etc/init.d/koha-zebra-daemon - $ sudo rm /etc/init.d/koha-zebraqueue-daemon -2) Remove Koha Databases +2) Remove Database and Indexes # MySQL $ mysql -u -p @@ -366,14 +297,11 @@ Uninstall Instructions $ zebraidx -c /etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init 3) Remove Koha Install Directories and Configuration Files + Don't forget about any crontab entries Tested on the following operating environments ============================================== -- Debian Etch 4.0 - -Installer Bug reports -===================== -Please send any installer bug reports to jmf AT liblime DOT com +- Debian Lenny 5.0 Other Notes =====================