BUGFIX: accidental deletion from start of README
[koha.git] / README.txt
1 Koha - award-winning GPL Integrated Library System
2
3 Koha aims to be a full-featured Integrated Library System. Developed
4 initially in New Zealand by Katipo Communications Ltd and first deployed
5 in January of 2000 for Horowhenua Library Trust, it is currently
6 maintained by a team of software providers and library technology staff
7 from around the globe.
8
9
10 STRUCTURE
11 =========
12
13 Koha 3.0 has been restructured from Koha 2.2 to use Zebra,
14 a high-performance, general-purpose structured text indexing and
15 retrieval engine.  Zebra speaks Z39.50, building on one of Koha's most
16 useful features.
17
18 General library data is held in MySQL, and Koha 3.0 supports MySQL 5,
19 using foreign keys and other recent features.
20
21 Apache 2 is the recommended web server and VirtualHost configuration
22 files are generated for it.
23
24
25 INSTALLATION
26 ============
27
28 Koha 3.0 comes with a new installer, based on MakeMaker, the tool that
29 is usually used to install CPAN modules.  This means that if you know
30 how to customise CPAN-installed modules, the same things should work
31 for you with Koha.
32
33 You need to have a server running MySQL 5, Zebra and some webserver
34 (preferably Apache) before installing Koha.  Create a database in
35 MySQL called koha and 
36
37 Default installation instructions:
38
39 1. perl Makefile.PL
40 2. make
41 3. sudo make install
42 4. ln -s /usr/lib/perl5/site-perl/*/koha/etc/koha-httpd.conf /etc/apache2/sites-available/koha
43 5. a2ensite koha && /etc/init.d/apache reload
44 6. zebrasrv -c /usr/lib/perl5/site-perl/*/koha/etc/koha-conf.xml
45 7. Browse to http://servername:8080/ and answer the questions
46
47 OR if you want to install all dependencies from CPAN and are root, you can
48 replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and
49 may not be safe.  Nevertheless, it's pretty cool when it works.
50
51 For instructions on how to override the default settings, run
52 perldoc rewrite-config.PL
53
54
55 DEVELOPER NOTES
56
57 For instructions on how to package releases, run perldoc Makefile.PL