Bug 5549 : Calendar needed a change array_ref to hash_ref

[koha.git] / INSTALL.ubuntu

diff --git a/INSTALL.ubuntu b/INSTALL.ubuntu
index 203c5f6..2bedddc 100644 (file)
--- a/INSTALL.ubuntu
+++ b/INSTALL.ubuntu
@@ -3,14 +3,15 @@ Installation Guide for Installing Koha on Ubuntu Jaunty (9.04) with MySQL 5
 =============================
 
 Copyright (C) 2007, 2008 LibLime (http://liblime.com)
 =============================
 
 Copyright (C) 2007, 2008 LibLime (http://liblime.com)

+Some parts copyright 2010 Chris Nighswonger

 
 

-Original author: Joshua Ferraro (jmf AT liblime DOT com)
+Original author: Joshua Ferraro

 Modified for Ubuntu by: Chris Nighswonger (cnighswonger AT foundations DOT edu)
 
 Feedback/bug reports: Koha Developer's List:
 Modified for Ubuntu by: Chris Nighswonger (cnighswonger AT foundations DOT edu)
 
 Feedback/bug reports: Koha Developer's List:

-http://lists.koha.org/mailman/listinfo/koha-devel
+http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel

 
 

-This document last modified: 22 June 2009
+This document last modified: 19 May 2010

 
 Installation Instructions
 =============================
 
 Installation Instructions
 =============================


@@ -30,7 +31,7 @@ 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:
 
 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
+http://wiki.koha-community.org/wiki/Encoding_and_Character_Sets_in_Koha

 
 You can verify your system locale by typing the following command:
 
 
 You can verify your system locale by typing the following command:
 


@@ -51,17 +52,17 @@ Run the following command to update your system:
 1.4.1 Option A: Download Koha via Git (optional)
 
     $ sudo apt-get install git-core git-email
 1.4.1 Option A: Download Koha via Git (optional)
 
     $ sudo apt-get install git-core git-email

-    $ git clone git://git.koha.org/pub/scm/koha.git kohaclone
+    $ git clone git://git.koha-community.org/koha.git kohaclone

     $ cd kohaclone
     $ git checkout -b myinstall origin
 
 Note: for more information about Git, please see the Koha Git Usage Guide:
 
     $ 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.org
+1.4.2 Option B: Download Koha from http://download.koha-community.org

 
 

-    $ wget http://download.koha.org/koha-3.00.02.tar.gz
+    $ wget http://download.koha-community.org/koha-3.00.02.tar.gz

     ( Note: use the latest stable version)
 
 1.5 Install additional Ubuntu dependencies
     ( Note: use the latest stable version)
 
 1.5 Install additional Ubuntu dependencies


@@ -155,6 +156,8 @@ When the configuration is completed CPAN will install the Perl modules.
 
     /etc/perl/XML/SAX/ParserDetails.ini
 
 
     /etc/perl/XML/SAX/ParserDetails.ini
 

+    You will need to move the entire section for '[XML::LibXML::SAX::Parser]' to the bottom of the ini file.
+

 2.4 Install DBD::mysql Perl module
 
 In order to handle UTF-8 correctly, Koha requires at least version 4.004
 2.4 Install DBD::mysql Perl module
 
 In order to handle UTF-8 correctly, Koha requires at least version 4.004


@@ -254,7 +257,7 @@ If not running named virtual hosts (The default koha installation does not use n
 
 Run the following commands:
 
 
 Run the following commands:
 

-    $ sudo a2enmod rewrite
+    $ sudo a2enmod rewrite deflate

     $ sudo a2ensite koha
     $ sudo apache2ctl restart
 
     $ sudo a2ensite koha
     $ sudo apache2ctl restart
 


@@ -276,32 +279,39 @@ configured to run as the root user.
 
 To add a user do:
 
 
 To add a user do:
 

-       $ sudo adduser koha
-
+    $ sudo adduser koha

 
 Option 1: run the Zebra processes from the command line:
 
 
 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)
 
     $ 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 the Zebra process as a daemon, and add to startup process:

 
 Note that references to $SCRIPT_DIR refer to the directory where
 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
 
 
 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
     $ 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


@@ -309,12 +319,15 @@ Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
 
     $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
 
 
     $ 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
+  <path/to/koha>/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
 
 
 6. Run the Web Installer, populate the database, initial configuration of settings
 


@@ -336,33 +349,55 @@ Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
     Bibliographic data in MARC21 format
     $ misc/migration_tools/bulkmarcimport.pl -file /path/to/marc.iso2709
     Authority data in MARC21 format
     Bibliographic data in MARC21 format
     $ misc/migration_tools/bulkmarcimport.pl -file /path/to/marc.iso2709
     Authority data in MARC21 format

-       $ misc/migration_tools/bulkauthimport.pl -file /path/to/auth.iso2709
+    $ misc/migration_tools/bulkauthimport.pl -file /path/to/auth.iso2709

 
 7.2 Fast Index:
     $ misc/migration_tools/rebuild_zebra.pl -b -w
 
 
 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 index
-       updates scheduled as per 7.3 the indexing process will happen in the background,
-       but it will be orders of magnitude slower.
+    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').

 
 7.3 Schedule regular index updates
 
 7.3 Schedule regular index updates

-    run rebuild_zebra.pl -b -a -z as a regular cron job, check misc/cronjobs/crontab.example
-       for usage examples
+
+    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').

 
 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
 =======
 
 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 upgrading from a previous installation of Koha 3, you can
+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:
 
 use the following:
 

+ ./koha_perl_deps.pl -u -m # to identify new Perl dependencies
+
+Install any missing modules
+IMPORTANT: Koha 3.6.x uses Template::Toolkit, this must be installed
+before the webinstaller can run
+
+ sudo apt-get install libtemplate-perl
+

  perl Makefile.PL --prev-install-log /path/to/koha-install-log
  make
  make test
  sudo make upgrade
 
  perl Makefile.PL --prev-install-log /path/to/koha-install-log
  make
  make test
  sudo make upgrade
 

+Koha 3.4.x or later no longer stores items in biblio records so 
+if you are upgrading from an older 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
+
+ misc/maintenance/remove_items_from_biblioitems.pl --run
+ misc/migration_tools/rebuild_zebra.pl -b -r
+

 Uninstall Instructions
 =============================
 1) Stop Services:
 Uninstall Instructions
 =============================
 1) Stop Services:


@@ -392,7 +427,7 @@ Tested on the following operating environments
 
 Installer Bug reports
 =====================
 
 Installer Bug reports
 =====================

-Please log any installer bug reports at http://bugs.koha.org
+Please log any installer bug reports at http://bugs.koha-community.org

 
 Other Notes
 =====================
 
 Other Notes
 =====================