Bug 9456: (follow-up) add tooltip
[koha.git] / INSTALL.debian
index a418829..4547974 100644 (file)
@@ -1,13 +1,14 @@
 =============================
-Installation Guide for Installing Koha on Debian Lenny with MySQL 5
+Installation Guide for Installing Koha on Debian
 =============================
 
 Some parts copyright 2010 Chris Nighswonger
+Some parts copyright 2011 MJ Ray and software.coop
 
 Feedback/bug reports: Koha Developer's List:
 http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
 
-This document last modified: October 8, 2010
+This document last modified: 2012-March-20
 
 Installation Instructions
 =============================
@@ -17,19 +18,23 @@ as indicated or by running the command directly as root.
 
 1. Prepare System and Install Dependencies
 
-1.1 Install Debian Lenny via Businesscard CD
+1.1 Install Debian via Business Card CD
 
-    See http://www.debian.org/releases/lenny/debian-installer/
+    See http://www.debian.org/CD/netinst/
 
 1.2 Set up Indexdata apt sources for Yaz and Zebra packages
 
-Edit your /etc/apt/sources.list file and add the following:
+See the instructions from indexdata at
+http://ftp.indexdata.com/pub/debian/README
+
+At the time of writing, you need to create
+/etc/apt/sources.list.d/indexdata.list containing the following:
 
     # Index Data
-    deb http://ftp.indexdata.dk/debian lenny main
-    deb-src http://ftp.indexdata.dk/debian lenny main
+    deb http://ftp.indexdata.dk/debian squeeze main
+    deb-src http://ftp.indexdata.dk/debian squeeze main
 
-The Index Data packages are signed with a key you can install as follows:
+and add their archive signing key to your system:
 
     $ wget -O- http://ftp.indexdata.dk/debian/indexdata.asc | sudo apt-key add -
 
@@ -53,46 +58,38 @@ Note: for more information about Git, please see the Koha Git Usage Guide:
 1.3.2 Option B: Download Koha from http://download.koha-community.org
 
 Find the latest Koha stable version on http://download.koha-community.org
-and get it:
+and download it to your server with something like:
 
-    $ wget <URL> found on download.koha-community.org
+    $ wget <URL found on download.koha-community.org>
 
 1.4 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!
 
-Run shell script installing all necessary Debian packages, MySQL Server,
+Installing all necessary Debian packages, MySQL Server,
 Zebra and all Debian packaged Perl module required by Koha:
 
-    $ sudo install_misc/apt-get-debian-lenny.sh
+    $ sudo dpkg --set-selections < install_misc/debian.packages
+    $ sudo apt-get dselect-upgrade
 
-1.5 Install Perl dependencies that aren't packaged into Debian Lenny
-sources
+1.5 Install Perl dependencies that aren't packaged into Debian
 
 Run the following command:
 
-    $ sudo cpan Algorithm::CheckDigits SMS::Send HTTP::OAI IPC::Cmd \
-      Memoize::Memcached PDF::API2::Simple PDF::Table Storable Test::More \
-      Locale::Currency::Format DateTime Lingua::Stem::Snowball Text::CSV::Encoded \
-      UNIVERSAL::require YAML Authen::CAS::Client
+    $ perl koha_perl_deps.pl -m -u
+
+This will list whether any Perl dependencies are missing or need a
+later version and whether they are required.  You can then install
+them another way.  There may be packages on
+http://debian.koha-community.org or maybe you can build packages
+yourself or maybe you will need to install them locally with a command
+similar to
+
+    $ sudo cpan Graphics::Magick CHI CHI::Driver::Memcached
 
 Note: you may need to run CPAN initialization if you've not run cpan
-before:
-
-    /etc/perl/CPAN/Config.pm initialized.
-
-    CPAN is the world-wide archive of perl resources. It consists of about
-    100 sites that all replicate the same contents all around the globe.
-    Many countries have at least one CPAN site already. The resources
-    found on CPAN are easily accessible with the CPAN.pm module. If you
-    want to use CPAN.pm, you have to configure it properly.
-    
-    If you do not want to enter a dialog now, you can answer 'no' to this
-    question and I'll try to autoconfigure. (Note: you can revisit this
-    dialog anytime later by typing 'o conf init' at the cpan prompt.)
-    
-    Are you ready for manual configuration? [yes]
+before.  See http://search.cpan.org/~andk/CPAN/lib/CPAN.pm#CONFIGURATION
 
 When the configuration is completed CPAN will install the Perl modules.
 
@@ -130,13 +127,13 @@ 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 
+    $ misc/sax_parser_print.pl
 
 You should see something like:
 
     XML::LibXML::SAX::Parser=HASH(0x81fe220)
 
-If you are configured to use PurePerl or Expat, the script will say you have a problem and 
+If you are configured to use PurePerl or Expat, the script will say you have a problem and
 you'll need to edit your ini file to correct it.
 
 The file is typically located at:
@@ -194,22 +191,22 @@ Note: you may still see the usual Apache default site if your VirtualHost
       configuration isn't correct.  If Koha is the only web application running on the server,
       the command "sudo a2dissite default" may be a quick fix. For servers running other sites
       alongside Koha, see the Apache HTTPD manual section on virtual hosts for full
-      instructions (http://httpd.apache.org/docs/2.0/vhosts/).
+      instructions (http://httpd.apache.org/docs/2.2/vhosts/).
 
 5. Run the Web Installer, populate the database, initial configuration of settings
 
 Point your browser to http://<servername>:8080/
 
 Note: <servername> is (usually) the IP of your server, or localhost (if you are connecting
-      from the same machine Koha is installed on. You can verify the location by checking 
+      from the same machine Koha is installed on. You can verify the location by checking
       the VirtualHost settings for both the opac and intranet virtual hosts in koha-httpd.conf
 
-Koha will redirect you to the Web Installer where you can continue the setup. You will be prompted to enter in your DATABASE username and password. It is through this interface 
-that 
+Koha will redirect you to the Web Installer where you can continue the setup. You will be prompted to enter in your DATABASE username and password. It is through this interface
+that
 you can install the sample data for libraries, patrons, and much more.
 
-Be aware that removing sample data at a later time (when you may want to take the 
-server into production) may not be easy, and if your intent is to take this 
+Be aware that removing sample data at a later time (when you may want to take the
+server into production) may not be easy, and if your intent is to take this
 install from testing to production, go with minimal sample data (no patrons or bibliographic records).
 
 6. Configure and start Zebra
@@ -277,12 +274,13 @@ Edit the crontab for the koha user by running
     $ sudo -u <kohauser> crontab -e
 
 For Zebra indexing, you are looking for the example that begins with
-    
+
     # ZEBRA INDEX UPDATES with -z option, incremental index updates throughout the day
     # for both authorities and bibs
 
 It may be easiest to copy/paste the example into your own crontab and modify as necessary.
 
+You can also configure zebra-indexing as an background daemon, see http://wiki.koha-community.org/wiki/Background_indexing_with_Zebra
 
 7. What next?
 
@@ -309,23 +307,32 @@ Authority data in MARC21 format
     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', this is the user we set up in step 2.3).
 
-7.3 Schedule regular index updates
+7.3 Schedule regular index updates with cron ,or configure zebra indexing as a background daemon
+
     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', this is the user we set up in step 2.3).
 
+    To setup indexing in background see 6.2.2
+
 7.4 To enable public Z39.50/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 running in another language other than english, please
+switch to english before doing the upgrade, the templating system has
+changed and the templates will need to be regenerated.
+Once you have upgraded, please regenerate your templates in your
+chosen languages.
+
 If you are upgrading from a previous installation of Koha 3.x, you can
 use the following:
 
  ./koha_perl_deps.pl -u -m # to identify new Perl dependencies
 
 Install any missing modules
-IMPORTANT: Koha 3.4.x uses Template::Toolkit, this must be installed
+IMPORTANT: Koha 3.6.x uses Template::Toolkit, this must be installed
 before the webinstaller can run
 
  sudo apt-get install libtemplate-perl
@@ -335,7 +342,8 @@ before the webinstaller can run
  make test
  sudo make upgrade
 
-Koha 3.4.x no longer stores items in biblio records so as part of the
+Koha 3.4.x or later no longer stores items in biblio records so
+if you upgrading from an old version as part of the
 upgrade you will need to do the following two steps, they can take a
 long time (several hours) to complete for large databases
 
@@ -368,6 +376,7 @@ Uninstall Instructions
 Tested on the following operating environments
 ==============================================
 - Debian Lenny 5.0
+- Debian Squeeze 6.0
 
 Other Notes
 =====================