fixing nomenclature on files in misc/, adding a few new utilities
[wip/koha-chris_n.git] / README.txt
1 Koha - award-winning open-source Integrated Library System
2
3 Koha is the first open-source Integrated Library System. Developed initially in
4 New Zealand by Katipo Communications, Ltd and first deployed in January of 2000
5 for the Horowhenua Library Trust, it is currently maintained by a team of
6 software providers and library technology staff from around the globe. Learn
7 more about the Koha project at http://koha.org.
8
9 INSTALLATION
10 ============
11
12 Koha 3.0 comes with a new installer, based on MakeMaker, the tool that
13 is usually used to install CPAN modules.  This means that if you know
14 how to customise CPAN-installed modules, the same things should work
15 for you with Koha.  If not, don't worry.  If you want to customise the
16 installation more than described below, run "man ExtUtils::MakeMaker"
17
18 You need to have a server running MySQL 5 or PostgreSQL 8.2.5, Zebra
19 2.0.22 or greater and a webserver (preferably Apache2) before installing
20 Koha.
21  
22 MySQL 5: Create a database called 'koha,' owned by 'kohaadmin'
23 user, with a password set. Note: kohaadmin must have at least the
24 following privileges: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP,
25 ALTER, and LOCK TABLES.
26
27 PostgreSQL 8.2.5: Create a database called 'koha,' owned by 'kohaadmin' 
28 user, with a password set. Note: kohaadmin must be a superuser. You
29 must also add plpgsql to the koha database.
30
31 Default installation instructions:
32
33 1. perl Makefile.PL
34   (you will be prompted to answer a number of questions)
35 2. make
36 3.(optional) make test 
37 4. sudo make install
38 5. sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
39   (note that the path to koha-httpd.conf may be different depending on your
40   installation choices)
41 6. sudo a2enmod rewrite
42 7. sudo a2ensite koha && /etc/init.d/apache2 reload
43 8. sudo zebrasrv -f /etc/koha/koha-conf.xml
44   (note that you will want to run Zebra in daemon mode for a production
45   system)
46 9. Browse to http://servername:8080/ and answer the questions
47
48 OR if you want to install all dependencies from CPAN and are root, you can
49 replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and
50 may not be safe.  Nevertheless, it's pretty cool when it works.
51
52 The defaults will install Koha to places that follow relevant standards,
53 such as the File Hierarchy Standard.  If you want to install Koha to a
54 different directory like /opt/koha, then replace step 1 with (for example):
55
56 1. perl Makefile.PL INTRANET_CGI_DIR=/www/cgi-bin
57
58 You can change most of the defaults in a similar way, such as DB_HOST.
59 For full instructions on how to override the default settings, run
60
61 $ perldoc rewrite-config.PL
62
63
64 IF YOU HAVE PROBLEMS
65 ====================
66
67 IF THIS IS A PRE-RELEASE TREE: please contact developers by email via
68 http://lists.nongnu.org/mailman/listinfo/koha-devel
69 or
70 http://dir.gmane.org/gmane.education.libraries.koha.devel
71
72 IF THIS IS A RELEASED VERSION: please see the support pages at
73 http://www.koha.org/
74
75 Released versions usually have three-digit numbers, like 3.00.01,
76 while other version number styles are usually snapshots or previews.
77
78
79 DEVELOPER NOTES
80 ===============
81
82 For instructions on how to package releases, run perldoc Makefile.PL