Merge remote branch 'kc/master'

[koha_fer] / INSTALL

diff --git a/INSTALL b/INSTALL
index 6605d1b..6f41267 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,7 +5,7 @@ Koha is the first open-source Integrated Library System. Developed initially in
 New Zealand by Katipo Communications, Ltd and first deployed in January of 2000
 for the Horowhenua Library Trust, it is currently maintained by a team of
 software providers and library technology staff from around the globe. Learn
 New Zealand by Katipo Communications, Ltd and first deployed in January of 2000
 for the Horowhenua Library Trust, it is currently maintained by a team of
 software providers and library technology staff from around the globe. Learn

-more about the Koha project at http://koha.org.
+more about the Koha project at http://koha-community.org.

 
 INSTALLATION
 ============
 
 INSTALLATION
 ============


@@ -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"
 
 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.
 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,
 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
 
 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
 
 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-community.org/bugzilla3/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
 2. make
 3.(optional) make test 
 4. sudo make install


@@ -45,6 +56,7 @@ Default installation instructions:
   (note that you will want to run Zebra in daemon mode for a production
   system)
 9. Browse to http://servername:8080/ and answer the questions
   (note that you will want to run Zebra in daemon mode for a production
   system)
 9. Browse to http://servername:8080/ and answer the questions

+10. Optionally add a robots.txt file.  See README.robots for details

 
 OR if you want to install all dependencies from CPAN and are root, you can
 replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and
 
 OR if you want to install all dependencies from CPAN and are root, you can
 replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and


@@ -62,16 +74,63 @@ For full instructions on how to override the default settings, run
 $ perldoc rewrite-config.PL
 
 
 $ perldoc rewrite-config.PL
 
 

+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
+
+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
 ====================
 
 IF THIS IS A PRE-RELEASE TREE: please contact developers by email via
 IF YOU HAVE PROBLEMS
 ====================
 
 IF THIS IS A PRE-RELEASE TREE: please contact developers by email via

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

 or
 http://dir.gmane.org/gmane.education.libraries.koha.devel
 
 IF THIS IS A RELEASED VERSION: please see the support pages at
 or
 http://dir.gmane.org/gmane.education.libraries.koha.devel
 
 IF THIS IS A RELEASED VERSION: please see the support pages at

-http://www.koha.org/
+http://www.koha-community.org/

 
 Released versions usually have three-digit numbers, like 3.00.01,
 while other version number styles are usually snapshots or previews.
 
 Released versions usually have three-digit numbers, like 3.00.01,
 while other version number styles are usually snapshots or previews.