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