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