Koha/README.txt
root 85684e1351 corrected init script name for apache2
Signed-off-by: Chris Cormack <crc@liblime.com>
Signed-off-by: Joshua Ferraro <jmf@liblime.com>
2007-11-06 06:24:50 -06:00

84 lines
3 KiB
Text

Koha - award-winning GPL Integrated Library System
Koha aims to be a full-featured Integrated Library System. Developed
initially in New Zealand by Katipo Communications Ltd and first deployed
in January of 2000 for Horowhenua Library Trust, it is currently
maintained by a team of software providers and library technology staff
from around the globe.
STRUCTURE
=========
Koha 3.0 has been restructured from Koha 2.2 to use Zebra,
a high-performance, general-purpose structured text indexing and
retrieval engine. Zebra speaks Z39.50, building on one of Koha's most
useful features.
General library data is held in MySQL, and Koha 3.0 supports MySQL 5,
using foreign keys and other recent features.
Apache 2 is the recommended web server and VirtualHost configuration
files are generated for it.
INSTALLATION
============
Koha 3.0 comes with a new installer, based on MakeMaker, the tool that
is usually used to install CPAN modules. This means that if you know
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, Zebra and some webserver
(preferably Apache) before installing Koha. Create a database in
MySQL called koha, owned by a kohaadmin user, with a password set.
Default installation instructions:
0. export MYSQL_PASS=thePasswordYouChose
1. perl Makefile.PL
2. make
3. sudo make install
4. ln -s /usr/share/koha/etc/koha-httpd.conf /etc/apache2/sites-available/koha
5. a2ensite koha && /etc/init.d/apache2 reload
6. zebrasrv -c /usr/share/koha/etc/koha-conf.xml
7. Browse to http://servername:8080/ and answer the questions
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
may not be safe. Nevertheless, it's pretty cool when it works.
The defaults will install Koha to places that follow relevant standards,
such as the File Hierarchy Standard. If you want to install Koha to a
different directory like /opt/koha, then replace step 1 with:
1a. export PREFIX=/opt/koha
1b. export CGI_DIR=/opt/koha/cgi
1c. export LOG_DIR=/opt/koha/log
1d. perl Makefile.PL PREFIX=/opt/koha
You can change most of the defaults in a similar way, such as MYSQL_HOST.
For full instructions on how to override the default settings, run
perldoc rewrite-config.PL
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
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/
Released versions usually have three-digit numbers, like 3.00.01,
while other version number styles are usually snapshots or previews.
DEVELOPER NOTES
===============
For instructions on how to package releases, run perldoc Makefile.PL