Bug 6679: Fixing admin/aqplain :encoding(UTF-8) gives strict validation
[koha.git] / INSTALL.ubuntu
blob815a4e682a1ce3a6d562b542776eada0b0d5cb80
1 =============================
2 Installation Guide for Installing Koha on Ubuntu Jaunty (9.04) with MySQL 5
3 =============================
5 Copyright (C) 2007, 2008 LibLime (http://liblime.com)
6 Some parts copyright 2010 Chris Nighswonger
8 Original author: Joshua Ferraro
9 Modified for Ubuntu by: Chris Nighswonger (cnighswonger AT foundations DOT edu)
11 Feedback/bug reports: Koha Developer's List:
12 http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
14 This document last modified: 19 May 2010
16 Installation Instructions
17 =============================
19 All commands can be performed as a system user with sudo privileges,
20 as indicated or by running the command directly as root.
22 1. Prepare System and Install Dependencies
24 1.1 Install Ubuntu Jaunty via CD
26 See http://www.ubuntu.com/getubuntu/download
28 1.2 Set up your locale
30 Your locale should be set to UTF-8, as should Apache2 and MySQL 5.
31 This step is VERY IMPORTANT for a UNICODE compliant system. Please
32 read over the following document carefully:
34 http://wiki.koha-community.org/wiki/Encoding_and_Character_Sets_in_Koha
36 You can verify your system locale by typing the following command:
38     $ locale
40 IMPORTANT:  You _MUST_ follow all the steps outlined there for
41             Apache2, MySQL 5, etc. BEFORE you install Koha.
43 1.3 Install the Yaz and Zebra packages
45 Run the following command to update your system:
47     $ sudo apt-get update
48     $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
50 1.4 Get Koha
52 1.4.1 Option A: Download Koha via Git (optional)
54     $ sudo apt-get install git-core git-email
55     $ git clone git://git.koha-community.org/koha.git kohaclone
56     $ cd kohaclone
57     $ git checkout -b myinstall origin
59 Note: for more information about Git, please see the Koha Git Usage Guide:
61     http://wiki.koha-community.org/wiki/Version_Control_Using_Git
63 1.4.2 Option B: Download Koha from http://download.koha-community.org
65     $ wget http://download.koha-community.org/koha-3.00.02.tar.gz
66     ( Note: use the latest stable version)
68 1.5 Install additional Ubuntu dependencies
70 IMPORTANT:  You should only use CPAN for Perl dependencies which are NOT
71             available from the package maintainer. You have been warned!
73 Using the ubuntu.packages file included in the Koha source tree,
74 run the following:
76     $ sudo dpkg --set-selections < install_misc/ubuntu.packages
78 Now start dselect (you may need to 'sudo apt-get install dselect'):
80     $ sudo dselect
82 Choose [I]nstall and accept packages to be installed (hit return)
84 (may take a while)
86 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
88 1.6 Install Perl dependencies that aren't packaged into Ubuntu Jaunty
89 sources
91 Run the following command:
93     $ sudo cpan MARC::Crosswalk::DublinCore GD GD::Barcode::UPCE Email::Date \
94                 HTML::Scrubber Algorithm::CheckDigits::M43_001 Biblio::EndnoteStyle \
95                 Locale::Currency::Format
97 Note: you may need to run CPAN initialization if you've not run cpan
98 before:
100     /etc/perl/CPAN/Config.pm initialized.
102     CPAN is the world-wide archive of perl resources. It consists of about
103     100 sites that all replicate the same contents all around the globe.
104     Many countries have at least one CPAN site already. The resources
105     found on CPAN are easily accessible with the CPAN.pm module. If you
106     want to use CPAN.pm, you have to configure it properly.
108     If you do not want to enter a dialog now, you can answer 'no' to this
109     question and I'll try to autoconfigure. (Note: you can revisit this
110     dialog anytime later by typing 'o conf init' at the cpan prompt.)
112     Are you ready for manual configuration? [yes]
114 When the configuration is completed CPAN will install the Perl modules.
116 2. Configuration of dependencies
118 2.1 Update root MySQL password (if dselect didn't do it for you already)
120     $ sudo mysqladmin password <password>
122 2.2 Create the Koha database
124     Create the database and user with associated privileges:
126     $ mysqladmin -uroot -p<password> create <kohadatabasename>
127     $ mysql -uroot -p<password>
129     Welcome to the MySQL monitor.  Commands end with ; or \g.
130     Your MySQL connection id is 22
131     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
133     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
135     mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
136     Query OK, 0 rows affected (0.00 sec)
138     mysql> flush privileges;
139     Query OK, 0 rows affected (0.00 sec)
141     mysql> quit
143 2.3 Test your SAX Parser and correct where necessary
145     You must be sure you're using the XML::LibXML SAX parser, not Expat or PurePerl, both of which have outstanding bugs with pre-composed characters. You can test your SAX parser by running:
147     $ cd koha
148     $ misc/sax_parser_print.pl
150     You should see something like::
152     XML::LibXML::SAX::Parser=HASH(0x81fe220)
154     If you're using PurePerl or Expat, you'll need to edit your
155     ini file, typically located at:
157     /etc/perl/XML/SAX/ParserDetails.ini
159     You will need to move the entire section for '[XML::LibXML::SAX::Parser]' to the bottom of the ini file.
161 2.4 Install DBD::mysql Perl module
163 In order to handle UTF-8 correctly, Koha requires at least version 4.004
164 of the DBD::mysql Perl module. However, Debian Etch has a stable package
165 only for version 3.0008, so it is necessary to install the module  from CPAN.
166 DBD::mysql's test suite needs to use a MySQL 'test' DB which doesn't exist
167 anymore. So there are two options to install DBD::mysql:
169   (1) install without test suite,
170   (2) install with test suite requiring a test MySQL DB creation.
172 2.4.1 Install without test suite
174 Force install DBD::mysql:
176     $ sudo cpan
177     cpan> force install DBD::mysql
179 2.4.2 Create test database in order to install DBD::mysql
181 Because of DBD::mysql's test suite, it is necessary to temporarily create a
182 test database and user:
184     $ mysql -uroot -p<password>
186     Create the database and user with associated privileges:
188     Welcome to the MySQL monitor.  Commands end with ; or \g.
189     Your MySQL connection id is 22
190     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
192     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
194     mysql> create database test;
195     Query OK, 1 row affected (0.00 sec)
197     mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
198     Query OK, 0 rows affected (0.00 sec)
199     (test database, user, and password can be different if need be)
201     mysql> flush privileges;
202     Query OK, 0 rows affected (0.00 sec)
204     mysql> quit
206 Next install DBD::mysql:
208     $ sudo cpan
210     cpan> o conf makepl_arg
211     (get current value of this CPAN parameter)
213     cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
215     cpan> install DBD::mysql
217     cpan> o conf makepl_arg ''
219     OR
221     cpan> o conf makepl_arg '<old setting>'
223     (restore this setting so as to not interfere with future CPAN installs).
226 Finally, remove the test database:
228     $ mysql -uroot -p<password>
230     mysql> drop database test;
231     Query OK, 1 row affected (0.00 sec)
233     mysql> exit
234     Bye
236 3. Run the Koha installer
238     $ perl Makefile.PL
239     ( answer questions )
240     $ make
241     $ make test
242     $ sudo make install
244 4. Configure and start Apache
245     $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
246     (note that the path to koha-httpd.conf may be different depending on your
247     installation choices)
249 Add the following lines to /etc/apache2/ports.conf:
251     Listen 80
252     Listen 8080
254 If not running named virtual hosts (The default koha installation does not use named virtual hosts.), comment out the following line:
256     NameVirtualHost *:80
258 Run the following commands:
260     $ sudo a2enmod rewrite deflate
261     $ sudo a2ensite koha
262     $ sudo apache2ctl restart
264 Note: you may still see the usual Apache default site if your VirtualHost
265 configuration isn't correct.  The command "sudo a2dissite default" may be a
266 quick fix, but may have side-effects.  See the Apache HTTPD manual section on
267 virtual hosts for full instructions.
269 5. Configure and start Zebra
271 Note: it's recommended that you daemonize the Zebra process and add it to your
272 startup profile. For a non-production test/development installation, running
273 Zebra from the command line can be useful. Pick from the two available options
274 below, or roll your own :-)
276 Note: it's also recommended that you create a Koha system user, which you will
277 have specified during the install process. Alternatively, Zebra can be
278 configured to run as the root user.
280 To add a user do:
282     $ sudo adduser koha
284 Option 1: run the Zebra processes from the command line:
286 1.1 Zebra Search Server
288 This process send responses to search requests sent by Koha or
289 Z39.50/SRU/SRW clients.
291     $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
292     (note that the path to koha-conf.xml may be different depending on your
293     installation choices)
295 Note: the user you run Zebra as will be the only user with write permission
296       on the Zebra index; in development mode, you may wish to use your
297       system user.
299 1.2 Zebra Indexer
301 Added/updated/deleted records in Koha MySQL database must be indexed
302 into Zebra. A specific script must be launched each time a bibliographic
303 or an authority record is edited.
305     $ sudo -u ${KOHA_USER} misc/migration_tools/rebuild_zebra -z -b -a
306     NOTE: This script should be run as the kohauser (the default is 'koha').
308 Option 2: run the Zebra process as a daemon, and add to startup process:
310 Note that references to $SCRIPT_DIR refer to the directory where
311 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
313 1.1 Zebra Search Server
315     $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh  /etc/init.d/koha-zebra-daemon
316     (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
317     $ sudo update-rc.d koha-zebra-daemon defaults
318     ( Note: see man chkconfig(8) on other distros )
320     $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
322 1.2 Zebra Indexer
324 Add an entry in Koha user crontab to scheduled added/updated/deleted records
325 indexing by Zebra with this command:
327   <path/to/koha>/misc/migration_tools/rebuild_zebra -z -b -a
329 See check misc/cronjobs/crontab.example for usage examples.
330 NOTE: This job should be setup under the kohauser (the default is 'koha').
332 6. Run the Web Installer, populate the database, initial configuration of settings
334     Point your browser to http://<servername>:8080/
336     It should redirect you to the Web Installer where you can continue the setup.
337     You can install the sample data for libraries, patrons, etc. via the Web Installer
339 7. What next?
341     Once the installer has completed, you can import and index MARC records from the
342     command line thusly (Note: you can also use the 'Stage MARC records for import' from
343     the Tools area of Koha's Staff Client to import a batch of MARC records):
345     $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
346       (note: use the correct path to your koha-conf.xml)
348 7.1 Import:
349     Bibliographic data in MARC21 format
350     $ misc/migration_tools/bulkmarcimport.pl -file /path/to/marc.iso2709
351     Authority data in MARC21 format
352     $ misc/migration_tools/bulkauthimport.pl -file /path/to/auth.iso2709
354 7.2 Fast Index:
355     $ misc/migration_tools/rebuild_zebra.pl -b -w
357     Once the indexing has completed, you will be able to search for records in your system.
358     NOTE: This script should be run as the kohauser (the default is 'koha').
360 7.3 Schedule regular index updates
362     You need to run rebuild_zebra.pl -b -a -z as a regular cron job in orde to pick up new bibs
363     and items as you add them. Check misc/cronjobs/crontab.example for usage examples. See 7.0 above.
364     NOTE: This job should be setup under the kohauser (the default is 'koha').
366 7.4 To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
367     change the <listen> options to listen on a TCP port; then restart the zebra daemon.
369 UPGRADE
370 =======
371 If you are running in another language other than english, please
372 switch to english before doing the upgrade, the templating system has
373 changed and the templates will need to be regenerated.
374 Once you have upgraded, please regenerate your templates in your
375 chosen languages.
377 If you are upgrading from a previous installation of Koha 3.x, you can
378 use the following:
380  ./koha_perl_deps.pl -u -m # to identify new Perl dependencies
382 Install any missing modules
383 IMPORTANT: Koha 3.4.x uses Template::Toolkit, this must be installed
384 before the webinstaller can run
386  sudo apt-get install libtemplate-perl
388  perl Makefile.PL --prev-install-log /path/to/koha-install-log
389  make
390  make test
391  sudo make upgrade
393 Koha 3.4.x no longer stores items in biblio records so as part of the
394 upgrade you will need to do the following two steps, they can take a
395 long time (several hours) to complete for large databases
397  misc/maintenance/remove_items_from_biblioitems.pl --run
398  misc/migration_tools/rebuild_zebra.pl -b -r
400 Uninstall Instructions
401 =============================
402 1) Stop Services:
403    $ sudo a2dissite koha
404    $ sudo rm /etc/apache2/sites-available/koha
405    $ sudo apache2ctl restart
407    $ sudo update-rc.d koha-zebra-daemon remove
408    $ sudo rm /etc/init.d/koha-zebra-daemon
410 2) Remove Database and Indexes
412    # MySQL
413    $ mysql -u<kohauser> -p<kohapassword>
414    > drop database koha;
416    # Zebra Indexes
417    $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
418    $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
420 3) Remove Koha Install Directories and Configuration Files
421    Don't forget about any crontab entries
423 Tested on the following operating environments
424 ==============================================
425 - Ubuntu Jaunty Jackalope 9.04
427 Installer Bug reports
428 =====================
429 Please log any installer bug reports at http://bugs.koha-community.org
431 Other Notes
432 =====================
433 This file is part of Koha
435 Koha is free software; you can redistribute it and/or modify it under the
436 terms of the GNU General Public License as published by the Free Software
437 Foundation; either version 2 of the License, or (at your option) any later
438 version.
440 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
441 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
442 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
443 You should have received a copy of the GNU General Public License along
444 with Koha; if not, write to the Free Software Foundation, Inc.,
445 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.