Bug 4472 Fix how   are injected into XSL files
[koha.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-community.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, MySQL 5 or PostgreSQL 8.2.5, Zebra
20 2.0.22 or greater and a webserver (preferably Apache2) before installing
21 Koha.
22
23 MySQL 5: Create a database called 'koha,' owned by 'kohaadmin'
24 user, with a password set. Note: kohaadmin must have at least the
25 following privileges: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP,
26 ALTER, and LOCK TABLES.
27
28 PostgreSQL 8.2.5: Create a database called 'koha,' owned by 'kohaadmin' 
29 user, with a password set. Note: kohaadmin must be a superuser. You
30 must also add plpgsql to the koha database. NOTE: PostgreSQL support in
31 Koha is experimental and should not be attempted for production systems
32 without a heavy investment in testing.
33
34 Default installation instructions:
35
36 1. perl Makefile.PL
37   (you will be prompted to answer a number of questions and you will
38   need to install some Perl dependencies)
39   WARNING:
40   1.1 A Perl library Koha depends on, MARC::File::XML may not work with Perl
41     5.10, see: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=2309),
42
43   1.2 recent versions of CGI::Session have caused some issues for users;
44   as of this release date, we suggest downloading the CGI::Session::serialize::yaml
45   tarball direct from CPAN and install it directly rather than using the cpan command
46
47 2. make
48 3.(optional) make test 
49 4. sudo make install
50 5. sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
51   (note that the path to koha-httpd.conf may be different depending on your
52   installation choices)
53 6. sudo a2enmod rewrite
54 7. sudo a2ensite koha && /etc/init.d/apache2 reload
55 8. sudo zebrasrv -f /etc/koha/koha-conf.xml
56   (note that you will want to run Zebra in daemon mode for a production
57   system)
58 9. Browse to http://servername:8080/ and answer the questions
59 10. Optionally add a robots.txt file.  See README.robots for details
60
61 OR if you want to install all dependencies from CPAN and are root, you can
62 replace steps 1-3 with "perl install-CPAN.pl" but this is non-standard and
63 may not be safe.  Nevertheless, it's pretty cool when it works.
64
65 The defaults will install Koha to places that follow relevant standards,
66 such as the File Hierarchy Standard.  If you want to install Koha to a
67 different directory like /opt/koha, then replace step 1 with (for example):
68
69 1. perl Makefile.PL INTRANET_CGI_DIR=/www/cgi-bin
70
71 You can change most of the defaults in a similar way, such as DB_HOST.
72 For full instructions on how to override the default settings, run
73
74 $ perldoc rewrite-config.PL
75
76
77 UPGRADE
78 =======
79 If you are upgrading from a previous installation of Koha 3, you can
80 use the following:
81
82  perl Makefile.PL --prev-install-log /path/to/koha-install-log
83  make
84  make test
85  sudo make upgrade
86
87 WHAT NEXT?
88
89 1. Running the Web Installer allows you to install sample data for libraries, patrons, etc.
90     but you may want to install additional data such as bibliographic and authorities.
91
92     Once the installer has completed, you can import and index MARC records from the
93     command line thusly (Note: you can also use the 'Stage MARC records for import' from
94     the Tools area of Koha's Staff Client to import a batch of MARC records):
95
96     $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
97       (note: use the correct path to your koha-conf.xml)
98
99 2. Import:
100     Bibliographic data in MARC21 format
101     $ misc/migration_tools/bulkmarcimport.pl -file /path/to/marc.iso2709
102     Authority data in MARC21 format
103     $ misc/migration_tools/bulkauthimport.pl -file /path/to/auth.iso2709
104
105 3. Fast Index:
106     $ misc/migration_tools/rebuild_zebra.pl -b -w
107
108     Once the indexing has completed, you will be able to search for records in your
109     system. NOTE: if you don't run the Fast Index utility, and you have the index
110     updates scheduled as per 7.3 the indexing process will happen in the background,
111     Once the indexing has completed, you will be able to search for records in your
112     system. NOTE: if you don't run the Fast Index utility, and you have the index
113     updates scheduled as per 7.3 the indexing process will happen in the background,
114     but it will be orders of magnitude slower.
115
116 4. Schedule regular index updates
117     run rebuild_zebra.pl -b -a -z as a regular cron job, check misc/cronjobs/crontab.example
118     for usage examples
119
120 5. To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
121     change the <listen> options to listen on a TCP port; then restart the zebra daemon.
122
123
124 IF YOU HAVE PROBLEMS
125 ====================
126
127 IF THIS IS A PRE-RELEASE TREE: please contact developers by email via
128 http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
129 or
130 http://dir.gmane.org/gmane.education.libraries.koha.devel
131
132 IF THIS IS A RELEASED VERSION: please see the support pages at
133 http://www.koha-community.org/
134
135 Released versions usually have three-digit numbers, like 3.00.01,
136 while other version number styles are usually snapshots or previews.
137
138
139 DEVELOPER NOTES
140 ===============
141
142 For instructions on how to package releases, run perldoc Makefile.PL