Updating INSTALL documents
This provides the following updates to the INSTALL documents: - Links updated to reflect currently available community resources at their new locations - Removes depreciated zebraqueue instructions - Adds notes regarding the proper usage of rebuild_zebra.pl NOTE: Remaining links will be updated as these resources are moved over and available Signed-off-by: Galen Charlton <gmcharlt@gmail.com>
This commit is contained in:
Chris Nighswonger
parent
8e23cbc28f
commit
9d85befee7
6 changed files with 103 additions and 83 deletions
2
INSTALL
2
INSTALL
|
|
@ -130,7 +130,7 @@ 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.
|
||||
|
|
|
|||
|
|
@ -3,13 +3,12 @@ Installation Guide for Installing Koha on Debian Etch with MySQL 5
|
|||
=============================
|
||||
|
||||
Copyright (C) 2007, 2008 LibLime (http://liblime.com)
|
||||
|
||||
Maintainer: Joshua Ferraro (jmf AT liblime DOT com)
|
||||
Some parts copyright 2010 Chris Nighswonger
|
||||
|
||||
Feedback/bug reports: Koha Developer's List:
|
||||
http://lists.koha.org/mailman/listinfo/koha-devel
|
||||
|
||||
This document last modified: 30 April 2008
|
||||
This document last modified: 19 May 2010
|
||||
|
||||
Installation Instructions
|
||||
=============================
|
||||
|
|
@ -69,7 +68,7 @@ Run the following command to update your system:
|
|||
|
||||
1.4.1 Option A: Download Koha via Git (optional)
|
||||
|
||||
$ git clone git://git.koha.org/pub/scm/koha.git kohaclone
|
||||
$ git clone git://git.koha-community.org/pub/scm/koha.git kohaclone
|
||||
$ cd kohaclone
|
||||
$ git checkout -b myinstall origin
|
||||
|
||||
|
|
@ -77,9 +76,9 @@ Note: for more information about Git, please see the Koha Git Usage Guide:
|
|||
|
||||
http://wiki.koha.org/doku.php?id=en:development:git_usage
|
||||
|
||||
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.00-beta.tar.gz
|
||||
$ wget http://download.koha-community.org/koha-3.00.00-beta.tar.gz
|
||||
( Note: use the latest stable version)
|
||||
|
||||
1.5 Install additional Debian dependencies
|
||||
|
|
@ -279,7 +278,7 @@ 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
|
||||
|
|
@ -307,42 +306,53 @@ Note: it's also recommended that you create a Koha system user, which you will
|
|||
have specified during the install process. Alternatively, Zebra can be
|
||||
configured to run as the root user.
|
||||
|
||||
Option 1: run the Zebra processes from the command line:
|
||||
Option 1: run the Zebra process from the command line:
|
||||
|
||||
1.1 Zebra Search Server
|
||||
|
||||
This process send responses to search requests sent by Koha or
|
||||
Z39.50/SRU/SRW clients.
|
||||
|
||||
Zebra Server:
|
||||
$ 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 (not recommended -- use rebuild_zebra in crontab instead):
|
||||
$ 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.
|
||||
|
||||
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
|
||||
( Note: see man chkconfig(8) on other distros )
|
||||
|
||||
|
||||
$ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
|
||||
|
||||
Zebraqueue Daemon (not recommended -- use rebuild_zebra in crontab instead):
|
||||
$ 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
|
||||
|
||||
$ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
|
||||
Add an entry in Koha user crontab to scheduled added/updated/deleted records
|
||||
indexing by Zebra with this command:
|
||||
|
||||
<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
|
||||
|
||||
|
|
@ -377,27 +387,26 @@ Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
|
|||
$ # If you had already scheduled lines, add them at the bottom.
|
||||
$ crontab my_crontab # This overwrites your scheduled jobs with the new ones.
|
||||
|
||||
If you want to check to confirm, you can run crontab -l again.
|
||||
If you want to check to confirm, you can run crontab -l again.
|
||||
NOTE: Be sure to add KOHA_CONF and PERL5LIB vars to the top of your cron jobs.
|
||||
|
||||
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
|
||||
$ 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 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
|
||||
run rebuild_zebra.pl -b -a -z as a regular cron job, check misc/cronjobs/crontab.example
|
||||
for usage examples. Do not schedule rebuild_zebra AND run zebraqueue. Pick one or the other.
|
||||
See 7.0 above.
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,10 +2,12 @@
|
|||
Installation Guide for Installing Koha on Debian Lenny with MySQL 5
|
||||
=============================
|
||||
|
||||
Some parts copyright 2010 Chris Nighswonger
|
||||
|
||||
Feedback/bug reports: Koha Developer's List:
|
||||
http://lists.koha.org/mailman/listinfo/koha-devel
|
||||
|
||||
This document last modified: 19 December 2009
|
||||
This document last modified: 19 May 2010
|
||||
|
||||
Installation Instructions
|
||||
=============================
|
||||
|
|
@ -37,7 +39,7 @@ The Index Data packages are signed with a key you can install as follows:
|
|||
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/pub/scm/koha.git kohaclone
|
||||
$ cd kohaclone
|
||||
$ git checkout -b myinstall origin
|
||||
|
||||
|
|
@ -45,12 +47,12 @@ Note: for more information about Git, please see the Koha Git Usage Guide:
|
|||
|
||||
http://wiki.koha.org/doku.php?id=en:development:git_usage
|
||||
|
||||
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
|
||||
|
||||
Find the latest Koha stable version on http://download.koha.org
|
||||
Find the latest Koha stable version on http://download.koha-community.org
|
||||
and get it:
|
||||
|
||||
$ wget <URL> found on download.koha.org
|
||||
$ wget <URL> found on download.koha-community.org
|
||||
|
||||
1.5 Install additional Debian dependencies
|
||||
|
||||
|
|
@ -198,11 +200,9 @@ into Zebra. A specific script must be launched each time a bibliographic
|
|||
or an authority record is edited.
|
||||
|
||||
$ 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').
|
||||
|
||||
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).
|
||||
|
||||
Option 2: run automatically Zebra processes as daemons:
|
||||
Option 2: run automatically Zebra process as a daemon:
|
||||
|
||||
Note that references to $SCRIPT_DIR refer to the directory where
|
||||
Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
|
||||
|
|
@ -213,7 +213,7 @@ Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
|
|||
(Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
|
||||
$ sudo update-rc.d koha-zebra-daemon defaults
|
||||
( Note: see man chkconfig(8) on other distros )
|
||||
|
||||
|
||||
$ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
|
||||
|
||||
1.2 Zebra Indexer
|
||||
|
|
@ -224,6 +224,7 @@ indexing by Zebra with this command:
|
|||
<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
|
||||
|
||||
|
|
@ -254,15 +255,14 @@ Authority data in MARC21 format
|
|||
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
|
||||
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.
|
||||
|
||||
|
|
|
|||
|
|
@ -383,7 +383,7 @@ server and the Apache server are configured to use the Unicode
|
|||
format (cf. 1.4).
|
||||
|
||||
|
||||
Download koha here: HYPERLINK "http://download.koha.org/koha-3.00.00-beta2.tar.gz" http://download.koha.org/koha-3.00.00-beta2.tar.gz
|
||||
Download koha here: HYPERLINK "http://download.koha-community.org/koha-3.00.00-beta2.tar.gz" http://download.koha-community.org/koha-3.00.00-beta2.tar.gz
|
||||
|
||||
3.1 Decompression of the archive koha 3.0
|
||||
|
||||
|
|
|
|||
|
|
@ -487,7 +487,7 @@ Install some packages that are needed to install Koha:
|
|||
==== Download Koha ====
|
||||
|
||||
|--------------------
|
||||
# wget http://download.koha.org/koha-3.00.00.tar.gz
|
||||
# wget http://download.koha-community.org/koha-3.00.00.tar.gz
|
||||
|--------------------
|
||||
|
||||
[FIXME: Check what will be the exact URL of the .tar.gz file for Koha 3]
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
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:
|
||||
http://lists.koha.org/mailman/listinfo/koha-devel
|
||||
|
||||
This document last modified: 22 June 2009
|
||||
This document last modified: 19 May 2010
|
||||
|
||||
Installation Instructions
|
||||
=============================
|
||||
|
|
@ -51,7 +52,7 @@ 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
|
||||
$ git clone git://git.koha.org/pub/scm/koha.git kohaclone
|
||||
$ git clone git://git.koha-community.org/pub/scm/koha.git kohaclone
|
||||
$ cd kohaclone
|
||||
$ git checkout -b myinstall origin
|
||||
|
||||
|
|
@ -59,9 +60,9 @@ Note: for more information about Git, please see the Koha Git Usage Guide:
|
|||
|
||||
http://wiki.koha.org/doku.php?id=en:development:git_usage
|
||||
|
||||
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
|
||||
|
|
@ -276,32 +277,39 @@ configured to run as the root user.
|
|||
|
||||
To add a user do:
|
||||
|
||||
$ sudo adduser koha
|
||||
|
||||
$ sudo adduser koha
|
||||
|
||||
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)
|
||||
|
||||
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.
|
||||
|
||||
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
|
||||
|
|
@ -309,12 +317,15 @@ Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
|
|||
|
||||
$ 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
|
||||
|
||||
$ sudo ${SCRIPT_DIR}/koha-zebraqueue-ctl.sh start
|
||||
Add an entry in Koha user crontab to scheduled added/updated/deleted records
|
||||
indexing by Zebra with this command:
|
||||
|
||||
<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
|
||||
|
||||
|
|
@ -336,19 +347,19 @@ 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
|
||||
$ 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
|
||||
|
||||
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
|
||||
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.
|
||||
|
|
|
|||
Loading…
Reference in a new issue