Conforming to AWS new terms of service

[koha.git] / INSTALL.debian

diff --git a/INSTALL.debian b/INSTALL.debian
index c0d205d..139a2f3 100644 (file)
--- a/INSTALL.debian
+++ b/INSTALL.debian
@@ -23,6 +23,10 @@ as indicated or by running the command directly as root.
 
 See http://www.debian.org/releases/etch/debian-installer/
 
+WARNING: use Perl 5.8 (a 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 Set up your locale
 
 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
@@ -106,11 +110,21 @@ 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
+                XML::RSS Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle POE \
+                Schedule::At DBD::SQLite GD SMS::Send HTTP::OAI
+
+
+  WARNINGS:
+  1.6.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.6.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
 
-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.
+  1.6.3 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.
 
 Note: you may need to run CPAN initialization if you've not run cpan
 before:
@@ -255,7 +269,7 @@ Finally, remove the test database:
     ( answer questions )
     $ make
     $ make test
-    $ sudo make install
+    $ sudo make install  #If doing a -dev install, skip the sudo!
 
 4. Configure and start Apache
     $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
@@ -265,7 +279,11 @@ Finally, remove the test database:
 Add the following lines to /etc/apache2/ports.conf:
 
     Listen 80
-    Listen 8080
+       Listen 8080
+
+(Note: It may be productive to use different DNS entries and NamedVirtualHosts
+directives in Apache to separate the staff and OPAC clients, to eliminate a 
+cross-client authentication nuisance, but it will work fine like this.)
 
 Run the following commands:
 
@@ -273,6 +291,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
@@ -338,18 +361,25 @@ 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:
+    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
 
 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 zebraqueue
-    daemon running, the indexin process will happen in the background, but it will be
-    orders of magnitude slower.
+    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.
 
-    To enable the 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.
+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
+    
+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
 =======
@@ -369,11 +399,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<kohauser> -p<kohapassword>
@@ -384,6 +412,7 @@ Uninstall Instructions
    $ zebraidx -c <prefix>/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
 ==============================================