Bug 5738 Display 856u As Image
[wip/koha-chris_n.git] / INSTALL.ubuntu
1 =============================
2 Installation Guide for Installing Koha on Ubuntu Jaunty (9.04) with MySQL 5
3 =============================
4
5 Copyright (C) 2007, 2008 LibLime (http://liblime.com)
6 Some parts copyright 2010 Chris Nighswonger
7
8 Original author: Joshua Ferraro
9 Modified for Ubuntu by: Chris Nighswonger (cnighswonger AT foundations DOT edu)
10
11 Feedback/bug reports: Koha Developer's List:
12 http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
13
14 This document last modified: 19 May 2010
15
16 Installation Instructions
17 =============================
18
19 All commands can be performed as a system user with sudo privileges,
20 as indicated or by running the command directly as root.
21
22 1. Prepare System and Install Dependencies
23
24 1.1 Install Ubuntu Jaunty via CD
25
26 See http://www.ubuntu.com/getubuntu/download
27
28 1.2 Set up your locale
29
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:
33
34 http://wiki.koha-community.org/wiki/Encoding_and_Character_Sets_in_Koha
35
36 You can verify your system locale by typing the following command:
37
38     $ locale
39
40 IMPORTANT:  You _MUST_ follow all the steps outlined there for
41             Apache2, MySQL 5, etc. BEFORE you install Koha.
42
43 1.3 Install the Yaz and Zebra packages
44
45 Run the following command to update your system:
46
47     $ sudo apt-get update
48     $ sudo apt-get install yaz idzebra-2.0 idzebra-2.0-doc
49
50 1.4 Get Koha
51
52 1.4.1 Option A: Download Koha via Git (optional)
53
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
58
59 Note: for more information about Git, please see the Koha Git Usage Guide:
60
61     http://wiki.koha-community.org/wiki/Version_Control_Using_Git
62
63 1.4.2 Option B: Download Koha from http://download.koha-community.org
64
65     $ wget http://download.koha-community.org/koha-3.00.02.tar.gz
66     ( Note: use the latest stable version)
67
68 1.5 Install additional Ubuntu dependencies
69
70 IMPORTANT:  You should only use CPAN for Perl dependencies which are NOT
71             available from the package maintainer. You have been warned!
72
73 Using the ubuntu.packages file included in the Koha source tree,
74 run the following:
75
76     $ sudo dpkg --set-selections < install_misc/ubuntu.packages
77
78 Now start dselect (you may need to 'sudo apt-get install dselect'):
79
80     $ sudo dselect
81
82 Choose [I]nstall and accept packages to be installed (hit return)
83
84 (may take a while)
85
86 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
87
88 1.6 Install Perl dependencies that aren't packaged into Ubuntu Jaunty
89 sources
90
91 Run the following command:
92
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
96
97 Note: you may need to run CPAN initialization if you've not run cpan
98 before:
99
100     /etc/perl/CPAN/Config.pm initialized.
101
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.
107
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.)
111
112     Are you ready for manual configuration? [yes]
113
114 When the configuration is completed CPAN will install the Perl modules.
115
116 2. Configuration of dependencies
117
118 2.1 Update root MySQL password (if dselect didn't do it for you already)
119
120     $ sudo mysqladmin password <password>
121
122 2.2 Create the Koha database
123
124     Create the database and user with associated privileges:
125
126     $ mysqladmin -uroot -p<password> create <kohadatabasename>
127     $ mysql -uroot -p<password>
128
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
132
133     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
134
135     mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
136     Query OK, 0 rows affected (0.00 sec)
137
138     mysql> flush privileges;
139     Query OK, 0 rows affected (0.00 sec)
140
141     mysql> quit
142
143 2.3 Test your SAX Parser and correct where necessary
144
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:
146
147     $ cd koha
148     $ misc/sax_parser_print.pl
149
150     You should see something like::
151
152     XML::LibXML::SAX::Parser=HASH(0x81fe220)
153
154     If you're using PurePerl or Expat, you'll need to edit your
155     ini file, typically located at:
156
157     /etc/perl/XML/SAX/ParserDetails.ini
158
159     You will need to move the entire section for '[XML::LibXML::SAX::Parser]' to the bottom of the ini file.
160
161 2.4 Install DBD::mysql Perl module
162
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:
168
169   (1) install without test suite,
170   (2) install with test suite requiring a test MySQL DB creation.
171
172 2.4.1 Install without test suite
173
174 Force install DBD::mysql:
175
176     $ sudo cpan
177     cpan> force install DBD::mysql
178
179 2.4.2 Create test database in order to install DBD::mysql
180
181 Because of DBD::mysql's test suite, it is necessary to temporarily create a
182 test database and user:
183
184     $ mysql -uroot -p<password>
185
186     Create the database and user with associated privileges:
187
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
191
192     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
193
194     mysql> create database test;
195     Query OK, 1 row affected (0.00 sec)
196
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)
200
201     mysql> flush privileges;
202     Query OK, 0 rows affected (0.00 sec)
203
204     mysql> quit
205
206 Next install DBD::mysql:
207
208     $ sudo cpan
209
210     cpan> o conf makepl_arg
211     (get current value of this CPAN parameter)
212
213     cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
214
215     cpan> install DBD::mysql
216
217     cpan> o conf makepl_arg ''
218
219     OR
220
221     cpan> o conf makepl_arg '<old setting>'
222
223     (restore this setting so as to not interfere with future CPAN installs).
224
225
226 Finally, remove the test database:
227
228     $ mysql -uroot -p<password>
229
230     mysql> drop database test;
231     Query OK, 1 row affected (0.00 sec)
232
233     mysql> exit
234     Bye
235
236 3. Run the Koha installer
237
238     $ perl Makefile.PL
239     ( answer questions )
240     $ make
241     $ make test
242     $ sudo make install
243
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)
248
249 Add the following lines to /etc/apache2/ports.conf:
250
251     Listen 80
252     Listen 8080
253
254 If not running named virtual hosts (The default koha installation does not use named virtual hosts.), comment out the following line:
255
256     NameVirtualHost *:80
257
258 Run the following commands:
259
260     $ sudo a2enmod rewrite deflate
261     $ sudo a2ensite koha
262     $ sudo apache2ctl restart
263
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.
268
269 5. Configure and start Zebra
270
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 :-)
275
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.
279
280 To add a user do:
281
282     $ sudo adduser koha
283
284 Option 1: run the Zebra processes from the command line:
285
286 1.1 Zebra Search Server
287
288 This process send responses to search requests sent by Koha or
289 Z39.50/SRU/SRW clients.
290
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)
294
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.
298
299 1.2 Zebra Indexer
300
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.
304
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').
307
308 Option 2: run the Zebra process as a daemon, and add to startup process:
309
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.
312
313 1.1 Zebra Search Server
314
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 )
319
320     $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
321
322 1.2 Zebra Indexer
323
324 Add an entry in Koha user crontab to scheduled added/updated/deleted records
325 indexing by Zebra with this command:
326
327   <path/to/koha>/misc/migration_tools/rebuild_zebra -z -b -a
328
329 See check misc/cronjobs/crontab.example for usage examples.
330 NOTE: This job should be setup under the kohauser (the default is 'koha').
331
332 6. Run the Web Installer, populate the database, initial configuration of settings
333
334     Point your browser to http://<servername>:8080/
335
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
338
339 7. What next?
340
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):
344
345     $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
346       (note: use the correct path to your koha-conf.xml)
347
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
353
354 7.2 Fast Index:
355     $ misc/migration_tools/rebuild_zebra.pl -b -w
356
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').
359
360 7.3 Schedule regular index updates
361
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').
365
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.
368
369 UPGRADE
370 =======
371 If you are upgrading from a previous installation of Koha 3, you can
372 use the following:
373
374  ./koha_perl_deps.pl -u -m # to identify new Perl dependencies
375  perl Makefile.PL --prev-install-log /path/to/koha-install-log
376  make
377  make test
378  sudo make upgrade
379
380 Uninstall Instructions
381 =============================
382 1) Stop Services:
383    $ sudo a2dissite koha
384    $ sudo rm /etc/apache2/sites-available/koha
385    $ sudo apache2ctl restart
386
387    $ sudo update-rc.d koha-zebra-daemon remove
388    $ sudo rm /etc/init.d/koha-zebra-daemon
389
390 2) Remove Database and Indexes
391
392    # MySQL
393    $ mysql -u<kohauser> -p<kohapassword>
394    > drop database koha;
395
396    # Zebra Indexes
397    $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
398    $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
399
400 3) Remove Koha Install Directories and Configuration Files
401    Don't forget about any crontab entries
402
403 Tested on the following operating environments
404 ==============================================
405 - Ubuntu Jaunty Jackalope 9.04
406
407 Installer Bug reports
408 =====================
409 Please log any installer bug reports at http://bugs.koha-community.org
410
411 Other Notes
412 =====================
413 This file is part of Koha
414
415 Koha is free software; you can redistribute it and/or modify it under the
416 terms of the GNU General Public License as published by the Free Software
417 Foundation; either version 2 of the License, or (at your option) any later
418 version.
419
420 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
421 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
422 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
423 You should have received a copy of the GNU General Public License along
424 with Koha; if not, write to the Free Software Foundation, Inc.,
425 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.