Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Bug 7759, update of install files to use background indexing (and som…

…e whitespace tidy)

Signed-off-by: Mason James <mtj @ kohaaloha.com>
Signed-off-by: Paul Poulain <paul.poulain@biblibre.com>
  • Loading branch information...
commit dad005a8a138f82858c15c5f16477502c868ac63 1 parent 7030a4f
@tajoli tajoli authored PaulPoulain committed
View
14 INSTALL
@@ -36,7 +36,7 @@ Default installation instructions:
perl translate install fr-FR # or use your preferred language codes
2. make
-3.(optional) make test
+3.(optional) make test
4. sudo make install
5. sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
(note that the path to koha-httpd.conf may be different depending on your
@@ -68,7 +68,7 @@ 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.
+changed and the templates will need to be regenerated.
Once you have upgraded, please regenerate your templates in your
chosen languages.
@@ -94,7 +94,7 @@ Use the packaged version or install from CPAN
sudo make upgrade
Koha 3.4.x or later no longer stores items in biblio records.
-If you are upgrading from an older version ou will need to do the
+If you are upgrading from an older version ou will need to do the
following two steps, they can take a long time (several hours) to
complete for large databases
@@ -125,14 +125,12 @@ WHAT NEXT?
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
+ run rebuild_zebra.pl -b -a -z as a regular cron job, check the 'misc/cronjobs/crontab.example' file for usage examples
+
+ You can also configure zebra-indexing as an background daemon, see http://wiki.koha-community.org/wiki/Background_indexing_with_Zebra
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.
View
24 INSTALL.debian
@@ -8,7 +8,7 @@ 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: 2011-06-19
+This document last modified: 2012-March-20
Installation Instructions
=============================
@@ -127,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:
@@ -198,15 +198,15 @@ Note: you may still see the usual Apache default site if your VirtualHost
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
@@ -274,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?
@@ -306,11 +307,14 @@ 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.
View
5 INSTALL.fedora7
@@ -1,3 +1,8 @@
+THIS FILE IS TOO OLD AND NOT UPDATED.
+CHECK KOHA WIKI:http://wiki.koha-community.org
+CHECK OTHERS INSTALL FILES
+ASK IN KOHA MAILING LIST
+
=============================
Installation Guide for Installing Koha on Fedora Core 7
=============================
View
107 INSTALL.opensuse
@@ -5,11 +5,11 @@ Version for openSUSE 11.3 adapted by Freek de Kruijf - freek -at- opensuse -dot-
No liability for the contents of this document can be accepted.
-Feedback/bug reports: Koha Developer's List:
+Feedback/bug reports: Koha Developer's List:
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
-This document last modified: 15 Oct 2010
+This document last modified: 20 Mar 2012
== Installation Instructions ==
@@ -19,7 +19,7 @@ The installation of Linux system described below is a basic, it is not designed
This document describes the different stages of installing the software Koha 3 on the openSUSE 11.3 Linux distribution in a "new" computer, the author uses a VirtualBox virtual machine, that is, a virtual computer that will have its virtual hard disk contents COMPLETELY ERASED to install openSUSE and Koha!
-In this example, the virtual machine uses a bridged network connection, which mimics a separate computer in the local network, it's assumed that your server gets an IP address by DHCP that later will be changed to 192.168.1.16.
+In this example, the virtual machine uses a bridged network connection, which mimics a separate computer in the local network, it's assumed that your server gets an IP address by DHCP that later will be changed to 192.168.1.16.
You'll have to change this to the real IP address that your machine should get (or use DHCP, if that's the case).
@@ -34,7 +34,7 @@ Place the DVD in the drive and restart the machine. In the case of a virtualmach
After the "Welcome" screen, you'll get a First menu, with the following options:
----
-Boot from Hard Disk
+Boot from Hard Disk
Installation
@@ -42,7 +42,7 @@ Repair Installed System
Rescue System
-Firmware Test
+Firmware Test
Memory Test
----
@@ -58,8 +58,8 @@ Choose "Installation" (second command)
You'll see two Dropdown Lists: "Language" and "Keyboard Layout"
-This depends of your place and preference, naturally.
-I live in The Netherlands, and we use the English (US) Keyboard Layout but I prefer an Operating System in English.
+This depends of your place and preference, naturally.
+I live in The Netherlands, and we use the English (US) Keyboard Layout but I prefer an Operating System in English.
So I leave the default option selected for "Language" and "Keyboard Layout" to (English (US)).
Check the "I Agree to the License Terms" checkbox (under the "License Agreement" textbox).
@@ -269,7 +269,7 @@ koha-server login:
You may now login with your "root" user.
==== Changing the Hostname and Domain Name ====
-
+
Maybe you want to change the hostname, domain name and switch from DHCP to a Static IP address.
Changing the hostname and domain name will not be shown here, because we assume that was done according to your whishes during installation.
@@ -295,7 +295,7 @@ Press the ENTER key.
I want to disable IPv6, so I first go to the "Global Options" section (by pushing the key combination ALT+G to press the "G" letter in Global Options that is highlighted).
In the next screen, I push ALT+E to uncheck the "Enable IPv6" checkbox.
I'll get a dialog box with a Warning saying that "To apply this change a reboot is needed.".
-I just press ENTER on that dialog box, but I do NOT reboot (at least not yet).
+I just press ENTER on that dialog box, but I do NOT reboot (at least not yet).
Then I press Alt+V to go to the "Overview" (still in "Network Settings").
Then I press ALT+I to "Edit" the information for this Network Card.
@@ -350,8 +350,8 @@ For this you use vim to change the config file of sshd.
Find the lines starting with AcceptEnv and insert a # in front of these, There are three lines.
Afterwards these lines will look like:
|--------------------
-#AcceptEnv LANG LC_CTYPE LC_NUMERIC LC_TIME LC_COLLATE LC_MONETARY LC_MESSAGES
-#AcceptEnv LC_PAPER LC_NAME LC_ADDRESS LC_TELEPHONE LC_MEASUREMENT
+#AcceptEnv LANG LC_CTYPE LC_NUMERIC LC_TIME LC_COLLATE LC_MONETARY LC_MESSAGES
+#AcceptEnv LC_PAPER LC_NAME LC_ADDRESS LC_TELEPHONE LC_MEASUREMENT
#AcceptEnv LC_IDENTIFICATION LC_ALL
|--------------------
@@ -396,18 +396,18 @@ Inside yast, select Software -> Software Repositories
==== "Configured Software Repositories" screen ====
-When on this screen, you already see a table that has:
+When on this screen, you already see a table that has:
* as configured repositories (in the "Name" column)
** "Updates for openSUSE 11.3 11.3-1.82"
** "openSUSE-11.3 11.3-1.82"
** "openSUSE-11.3-Debug"
-** "openSUSE-11.3-Non-Oss" "openSUSE-11.3-Oss" ...
+** "openSUSE-11.3-Non-Oss" "openSUSE-11.3-Oss" ...
* at least the following repositories have an "x" in the "Enabled" column
** "Updates for openSUSE 11.3 11.3-1.82"
** "openSUSE-11.3-Oss"
* you still have to add the folowing repositiory to this list
-** "openSUSE BuildService - devel:languages:perl"
+** "openSUSE BuildService - devel:languages:perl"
Press ALT+A to Add Repositories.
==== "Media type" screen ====
@@ -486,7 +486,7 @@ We want to have en_US.UTF-8 in all LC_* variables. So, we'll do the following:
|--------------------
System -> Language
-The "Languages" screen should appear.
+The "Languages" screen should appear.
In the first section (Primary Language Settings):
@@ -667,8 +667,8 @@ Shutting down service MySQL done
Starting service MySQL done
|--------------------
-Now, let's type again the show variables like 'char%' mysql command to see if
-the character_set_variables have changed from latin1 to utf8 (character_set_filesystem
+Now, let's type again the show variables like 'char%' mysql command to see if
+the character_set_variables have changed from latin1 to utf8 (character_set_filesystem
will still read "binary" but I think that's OK:
|--------------------
myhost:/etc # mysql -p
@@ -702,11 +702,11 @@ Bye
=== Create the koha database and user with associated privileges ===
|--------------------
-# mysqladmin -uroot create koha -p
+# mysqladmin -uroot create koha -p
|--------------------
(you may name the koha database something different from koha)
-=== Grant privileges to a MySQL user to the koha database ===
+=== Grant privileges to a MySQL user to the koha database ===
Assuming that you want to have a MySQL user called "kohaadmin" to administer a database called "koha" with the password "kohapassword", you'd enter this:
|--------------------
@@ -754,7 +754,7 @@ You must be sure you're using the XML::LibXML SAX parser, not Expat or PurePerl,
|--------------------
# cd /root/koha-3.00.00/
-myhost:~/koha-3.00.00 # misc/sax_parser_print.pl
+myhost:~/koha-3.00.00 # misc/sax_parser_print.pl
|--------------------
You will probably see this:
@@ -762,7 +762,7 @@ You will probably see this:
XML::SAX::PurePerl=HASH(0x8356a4c)
|--------------------
-If you're using PurePerl (you probably are) or Expat, you'll need to edit your ParserDetails.ini file to use the LibXML Parser.
+If you're using PurePerl (you probably are) or Expat, you'll need to edit your ParserDetails.ini file to use the LibXML Parser.
To find the ParserDetails.ini file, you may use locate.
To do this, first update the locate database by running the updatedb command:
|--------------------
@@ -815,7 +815,7 @@ You will notice that a few dependencies need to be resolved, so a few other pack
|--------------------
myhost:/usr/lib/perl5/vendor_perl/5.10.0/XML/SAX # cd /root/koha-3.00.00
|--------------------
-After installation of a number of CPAN/perl packages we will run perl Makefile.PL to run the Koha installer.
+After installation of a number of CPAN/perl packages we will run perl Makefile.PL to run the Koha installer.
=== Using zypper to install CPAN modules ===
@@ -880,7 +880,7 @@ The commands show below need to be given one by one, because zypper will always
== Running the Makefile.PL module to configure Koha ==
My installation is a UNIMARC installation, so I'm answering unimarc to the "MARC format for Zebra indexing (marc21, unimarc) [marc21]" question below.
-If your Library uses the MARC21 format instead of UNIMARC, you should press ENTER to accept the default (which is marc21).
+If your Library uses the MARC21 format instead of UNIMARC, you should press ENTER to accept the default (which is marc21).
Because my bibliographic catalog will have mainly records in English and Arabic, I'm answering "en" (English) to the "Primary language for Zebra indexing (en, fr) [en]" question below.
@@ -1136,32 +1136,32 @@ cp koha-tmpl/opac-tmpl/prog/famfamfam/mini/note.gif blib/OPAC_TMPL_DIR/prog/famf
[many more lines beginning with "cp" should appear...]
-t/Amazon.t .................. ok
-t/Barcodes_PrinterConfig.t .. ok
-t/Bookfund.t ................ ok
-t/Bookseller.t .............. ok
-t/Boolean.t ................. ok
-t/Branch.t .................. ok
-t/Calendar.t ................ ok
-t/Charset.t ................. ok
+t/Amazon.t .................. ok
+t/Barcodes_PrinterConfig.t .. ok
+t/Bookfund.t ................ ok
+t/Bookseller.t .............. ok
+t/Boolean.t ................. ok
+t/Branch.t .................. ok
+t/Calendar.t ................ ok
+t/Charset.t ................. ok
t/Debug.t ................... # BEFORE use: $debug is not defined
# BEFORE use: $cgi_debug is not defined
t/Debug.t ................... 1/3 # AFTER use: $debug is 0
# AFTER use: $cgi_debug is 0
# Done.
-t/Debug.t ................... ok
-t/dummy.t ................... ok
-t/Input.t ................... ok
-t/Koha.t .................... ok
-t/Languages.t ............... ok
-t/Maintainance.t ............ ok
-t/Output.t .................. ok
-t/Record.t .................. ok
-t/Review.t .................. ok
+t/Debug.t ................... ok
+t/dummy.t ................... ok
+t/Input.t ................... ok
+t/Koha.t .................... ok
+t/Languages.t ............... ok
+t/Maintainance.t ............ ok
+t/Output.t .................. ok
+t/Record.t .................. ok
+t/Review.t .................. ok
t/Scrubber.t ................ 1/10 # Note: scrubber test output will have whitespace collapsed for readability
# done.
-t/Scrubber.t ................ ok
-t/Stats.t ................... ok
+t/Scrubber.t ................ ok
+t/Stats.t ................... ok
All tests successful.
Files=19, Tests=47, 3 wallclock secs ( 0.06 usr 0.08 sys + 2.12 cusr 0.25 csys = 2.51 CPU)
Result: PASS
@@ -1214,7 +1214,7 @@ Exit the shell and log back in.
|--------------------
myhost:/etc # exit
|--------------------
-After logging back in, type the following commands to check if
+After logging back in, type the following commands to check if
the KOHA_CONF and PERL5LIB environment variables have been correctly set:
|--------------------
myhost:~ # env | grep KOHA
@@ -1283,7 +1283,7 @@ At the beginning of the koha-httpd.conf file, under the commented NameVirtualHos
|--------------------
Listen 8080
|--------------------
-In that file, you should find two VirtualHost sections: one for the OPAC area of Koha and the other one for the Intranet.
+In that file, you should find two VirtualHost sections: one for the OPAC area of Koha and the other one for the Intranet.
If the two virtualHost directives - the lines that start with <nowiki><VirtualHost</nowiki> - in that file are set for the IP Address 127.0.0.2, replace them by the correct IP address of your server.
That file will have 2 ServerName directives (one for each of the 2 VirtualHosts).
@@ -1355,3 +1355,22 @@ If not you may have forgotten to open the 8080 port.
You may now login with your koha administrator username and password and reply to the several questions you will be asked.
+== Add Zebra Indexer ==
+
+Add an entry in Koha user crontab to process scheduled added/updated/deleted records
+indexing by Zebra. <script_dir>cronjobs/crontab.example contains examples for these cron jobs (and many more).
+
+NOTE: The cronjobs should be setup under the kohauser (the default is 'koha', but
+this is the user you set up in section 'Create the Koha User and Group').
+
+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
View
14 INSTALL.ubuntu
@@ -11,7 +11,7 @@ Modified for Ubuntu by: Chris Nighswonger (cnighswonger AT foundations DOT edu)
Feedback/bug reports: Koha Developer's List:
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
-This document last modified: 19 May 2010
+This document last modified: 20 March 2010
Installation Instructions
=============================
@@ -281,7 +281,7 @@ To add a user do:
Option 1: run the Zebra processes from the command line:
-1.1 Zebra Search Server
+5.1.1 Zebra Search Server
This process send responses to search requests sent by Koha or
Z39.50/SRU/SRW clients.
@@ -294,7 +294,7 @@ 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.
-1.2 Zebra Indexer
+5.1.2 Zebra Indexer
Added/updated/deleted records in Koha MySQL database must be indexed
into Zebra. A specific script must be launched each time a bibliographic
@@ -308,7 +308,7 @@ 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.
-1.1 Zebra Search Server
+5.2.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)
@@ -317,7 +317,7 @@ Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
$ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
-1.2 Zebra Indexer
+5.2.2 Zebra Indexer
Add an entry in Koha user crontab to scheduled added/updated/deleted records
indexing by Zebra with this command:
@@ -327,6 +327,8 @@ indexing by Zebra with this command:
See check misc/cronjobs/crontab.example for usage examples.
NOTE: This job should be setup under the kohauser (the default is 'koha').
+You can also configure zebra-indexing as an background daemon, see http://wiki.koha-community.org/wiki/Background_indexing_with_Zebra
+
6. Run the Web Installer, populate the database, initial configuration of settings
Point your browser to http://<servername>:8080/
@@ -361,6 +363,8 @@ NOTE: This job should be setup under the kohauser (the default is 'koha').
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').
+ You can also indexing in background, see 5.2.2 above
+
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.
View
14 INSTALL.ubuntu.lucid
@@ -11,7 +11,7 @@ Modified for Ubuntu by: Chris Nighswonger (cnighswonger AT foundations DOT edu)
Feedback/bug reports: Koha Developer's List:
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
-This document last modified: 11 Sep 2010
+This document last modified: 20 Marchp 2012
Installation Instructions
=============================
@@ -217,7 +217,7 @@ To add a user do:
Option 1: run the Zebra processes from the command line:
-1.1 Zebra Search Server
+5.1.1 Zebra Search Server
This process send responses to search requests sent by Koha or
Z39.50/SRU/SRW clients.
@@ -230,7 +230,7 @@ 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.
-1.2 Zebra Indexer
+5.1.2 Zebra Indexer
Added/updated/deleted records in Koha MySQL database must be indexed
into Zebra. A specific script must be launched each time a bibliographic
@@ -244,7 +244,7 @@ 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.
-1.1 Zebra Search Server
+5.2.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)
@@ -253,7 +253,7 @@ Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
$ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
-1.2 Zebra Indexer
+5.2.2 Zebra Indexer
Add an entry in Koha user crontab to scheduled added/updated/deleted records
indexing by Zebra with this command:
@@ -263,6 +263,8 @@ indexing by Zebra with this command:
See check misc/cronjobs/crontab.example for usage examples.
NOTE: This job should be setup under the kohauser (the default is 'koha').
+You can also configure zebra-indexing as an background daemon, see http://wiki.koha-community.org/wiki/Background_indexing_with_Zebra
+
6. Run the Web Installer, populate the database, initial configuration of settings
Point your browser to http://<servername>:8080/
@@ -297,6 +299,8 @@ NOTE: This job should be setup under the kohauser (the default is 'koha').
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').
+ You can also indexing in background, see 5.2.2 above
+
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.
Please sign in to comment.
Something went wrong with that request. Please try again.