(bug #3950) only show on shelf items

[koha.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 2233c68..df0990c 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -16,10 +16,10 @@ how to customise CPAN-installed modules, the same things should work
 for you with Koha.  If not, don't worry.  If you want to customise the
 installation more than described below, run "man ExtUtils::MakeMaker"
 
-You need to have a server running MySQL 5 or PostgreSQL 8.2.5, Zebra
+You need to have a server running Perl 5.8, MySQL 5 or PostgreSQL 8.2.5, Zebra
 2.0.22 or greater and a webserver (preferably Apache2) before installing
 Koha.
- 
+
 MySQL 5: Create a database called 'koha,' owned by 'kohaadmin'
 user, with a password set. Note: kohaadmin must have at least the
 following privileges: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP,
@@ -27,12 +27,23 @@ ALTER, and LOCK TABLES.
 
 PostgreSQL 8.2.5: Create a database called 'koha,' owned by 'kohaadmin' 
 user, with a password set. Note: kohaadmin must be a superuser. You
-must also add plpgsql to the koha database.
+must also add plpgsql to the koha database. NOTE: PostgreSQL support in
+Koha is experimental and should not be attempted for production systems
+without a heavy investment in testing.
 
 Default installation instructions:
 
 1. perl Makefile.PL
-  (you will be prompted to answer a number of questions)
+  (you will be prompted to answer a number of questions and you will
+  need to install some Perl dependencies)
+  WARNING:
+  1.1 A Perl library Koha depends on, MARC::File::XML may not work with Perl
+    5.10, see: http://bugs.koha.org/cgi-bin/bugzilla/show_bug.cgi?id=2309),
+
+  1.2 recent versions of CGI::Session have caused some issues for users;
+  as of this release date, we suggest downloading the CGI::Session::serialize::yaml
+  tarball direct from CPAN and install it directly rather than using the cpan command
+
 2. make
 3.(optional) make test 
 4. sudo make install
@@ -72,6 +83,43 @@ use the following:
  make test
  sudo make upgrade
 
+WHAT NEXT?
+
+1. Running the Web Installer allows you to install sample data for libraries, patrons, etc.
+    but you may want to install additional data such as bibliographic and authorities.
+
+    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)
+
+2. Import:
+    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
+
+3. 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,
+    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.
+
+4. Schedule regular index updates
+    run rebuild_zebra.pl -b -a -z as a regular cron job, check misc/cronjobs/crontab.example
+    for usage examples
+
+5. 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.
+
+
 IF YOU HAVE PROBLEMS
 ====================