Bug 6679 - [SIGNED-OFF] fix 3 perlcritic violations in C4/Items.pm
[koha.git] / INSTALL.ubuntu.lucid
1 =============================
2 Installation Guide for Installing Koha on Ubuntu Lucid Lynx (10.04 LTS) 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: 20 Marchp 2012
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 Lucid Lynx 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 Get Koha
44
45 1.3.1 Option A: Download Koha via Git (optional)
46
47     $ sudo apt-get install git-core git-email
48     $ git clone git://git.koha-community.org/koha.git kohaclone
49     $ cd kohaclone
50     $ git checkout -b myinstall origin
51
52 Note: for more information about Git, please see the Koha Git Usage Guide:
53
54     http://wiki.koha-community.org/wiki/Version_Control_Using_Git
55
56 1.3.2 Option B: Download Koha from http://download.koha-community.org
57
58     $ wget http://download.koha-community.org/koha-3.02.00.tar.gz
59     ( Note: use the latest stable version)
60
61 1.4 Install additional Ubuntu dependencies
62
63 IMPORTANT:  You should only use CPAN for Perl dependencies which are NOT
64             available from the package maintainer. You have been warned!
65
66 Using the ubuntu.packages file included in the Koha source tree,
67 run the following:
68
69     $ sudo dpkg --set-selections < install_misc/ubuntu.packages
70
71 Now start dselect (you may need to 'sudo apt-get install dselect'):
72
73     $ sudo dselect
74
75 Choose [I]nstall and accept packages to be installed (hit return)
76
77 (may take a while)
78
79 Choose [C]onfigure, [R]emove and [Q]uit until dselect has completed.
80
81 Note: If you are installing on an older version of Ubuntu, not all of the
82       packages listed in ubuntu.packages may be available as packages.  You
83       will want to verify which ones are installed and which ones not.
84       This can be done by running the following command:
85
86     $ install_misc/ubuntu-pkg-check.sh | grep none
87
88 When tracking down any "(none)" results, note that sometimes Ubuntu does the
89 right thing and installs a later, differently named version of the package in
90 place.  To see if this is happening, it is useful to run a command like:
91
92     $ dpkg --get-selections | grep [base_package_name]
93
94 1.5 Install Perl dependencies that aren't packaged into Ubuntu Lucid Lynx
95 sources
96
97 Run the following command:
98
99     $ sudo cpan HTTP::OAI Locale::Currency::Format Memoize::Memcached \
100                 PDF::API2::Simple Storable Text::CSV::Encoded CHI \
101                 CHI::Driver::Memcached
102
103 Note: you may need to run CPAN initialization if you've not run cpan
104 before:
105
106     /etc/perl/CPAN/Config.pm initialized.
107
108     CPAN is the world-wide archive of perl resources. It consists of about
109     100 sites that all replicate the same contents all around the globe.
110     Many countries have at least one CPAN site already. The resources
111     found on CPAN are easily accessible with the CPAN.pm module. If you
112     want to use CPAN.pm, you have to configure it properly.
113
114     If you do not want to enter a dialog now, you can answer 'no' to this
115     question and I'll try to autoconfigure. (Note: you can revisit this
116     dialog anytime later by typing 'o conf init' at the cpan prompt.)
117
118     Are you ready for manual configuration? [yes]
119
120 When the configuration is completed CPAN will install the Perl modules.
121
122 2. Configuration of dependencies
123
124 2.1 Update root MySQL password (if dselect didn't do it for you already)
125
126     $ sudo mysqladmin password <password>
127
128 2.2 Create the Koha database
129
130     Create the database and user with associated privileges:
131
132     $ mysqladmin -uroot -p<password> create <kohadatabasename>
133     $ mysql -uroot -p<password>
134
135     Welcome to the MySQL monitor.  Commands end with ; or \g.
136     Your MySQL connection id is 22
137     Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
138
139     Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
140
141     mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
142     Query OK, 0 rows affected (0.00 sec)
143
144     mysql> flush privileges;
145     Query OK, 0 rows affected (0.00 sec)
146
147     mysql> quit
148
149 2.3 Test your SAX Parser and correct where necessary
150
151     You must be sure you're using the XML::LibXML SAX parser, not Expat or
152     PurePerl, both of which have outstanding bugs with pre-composed
153     characters. You can test your SAX parser by running:
154
155     $ cd koha
156     $ misc/sax_parser_print.pl
157
158     You should see something like::
159
160     XML::LibXML::SAX::Parser=HASH(0x81fe220)
161
162     If you're using PurePerl or Expat, you'll need to edit your
163     ini file, typically located at:
164
165     /etc/perl/XML/SAX/ParserDetails.ini
166
167     You will need to move the entire section for '[XML::LibXML::SAX::Parser]'
168     to the bottom of the ini file.
169
170 3. Run the Koha installer
171
172     $ perl Makefile.PL
173     ( answer questions )
174     $ make
175     $ make test
176     $ sudo make install
177
178 4. Configure and start Apache
179     $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
180     (note that the path to koha-httpd.conf may be different depending on your
181     installation choices)
182
183 Add the following lines to /etc/apache2/ports.conf:
184
185     Listen 80
186     Listen 8080
187
188 If not running named virtual hosts (The default koha installation does not use
189 named virtual hosts.), comment out the following line:
190
191     NameVirtualHost *:80
192
193 Run the following commands:
194
195     $ sudo a2enmod rewrite deflate
196     $ sudo a2ensite koha
197     $ sudo apache2ctl restart
198
199 Note: you may still see the usual Apache default site if your VirtualHost
200 configuration isn't correct.  The command "sudo a2dissite default" may be a
201 quick fix, but may have side-effects.  See the Apache HTTPD manual section on
202 virtual hosts for full instructions.
203
204 5. Configure and start Zebra
205
206 Note: it's recommended that you daemonize the Zebra process and add it to your
207 startup profile. For a non-production test/development installation, running
208 Zebra from the command line can be useful. Pick from the two available options
209 below, or roll your own :-)
210
211 Note: it's also recommended that you create a Koha system user, which you will
212 have specified during the install process. Alternatively, Zebra can be
213 configured to run as the root user.
214
215 To add a user do:
216
217     $ sudo adduser koha
218
219 Option 1: run the Zebra processes from the command line:
220
221 5.1.1 Zebra Search Server
222
223 This process send responses to search requests sent by Koha or
224 Z39.50/SRU/SRW clients.
225
226     $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
227     (note that the path to koha-conf.xml may be different depending on your
228     installation choices)
229
230 Note: the user you run Zebra as will be the only user with write permission
231       on the Zebra index; in development mode, you may wish to use your
232       system user.
233
234 5.1.2 Zebra Indexer
235
236 Added/updated/deleted records in Koha MySQL database must be indexed
237 into Zebra. A specific script must be launched each time a bibliographic
238 or an authority record is edited.
239
240     $ sudo -u ${KOHA_USER} misc/migration_tools/rebuild_zebra -z -b -a
241     NOTE: This script should be run as the kohauser (the default is 'koha').
242
243 Option 2: run the Zebra process as a daemon, and add to startup process:
244
245 Note that references to $SCRIPT_DIR refer to the directory where
246 Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
247
248 5.2.1 Zebra Search Server
249
250     $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh  /etc/init.d/koha-zebra-daemon
251     (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
252     $ sudo update-rc.d koha-zebra-daemon defaults
253     ( Note: see man chkconfig(8) on other distros )
254
255     $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
256
257 5.2.2 Zebra Indexer
258
259 Add an entry in Koha user crontab to scheduled added/updated/deleted records
260 indexing by Zebra with this command:
261
262   <path/to/koha>/misc/migration_tools/rebuild_zebra -z -b -a
263
264 See check misc/cronjobs/crontab.example for usage examples.
265 NOTE: This job should be setup under the kohauser (the default is 'koha').
266
267 You can also configure zebra-indexing as an background daemon, see http://wiki.koha-community.org/wiki/Background_indexing_with_Zebra
268
269 6. Run the Web Installer, populate the database, initial configuration of settings
270
271     Point your browser to http://<servername>:8080/
272
273     It should redirect you to the Web Installer where you can continue the setup.
274     You can install the sample data for libraries, patrons, etc. via the Web Installer
275
276 7. What next?
277
278     Once the installer has completed, you can import and index MARC records from the
279     command line thusly (Note: you can also use the 'Stage MARC records for import' from
280     the Tools area of Koha's Staff Client to import a batch of MARC records):
281
282     $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
283       (note: use the correct path to your koha-conf.xml)
284
285 7.1 Import:
286     Bibliographic data in MARC21 format
287     $ misc/migration_tools/bulkmarcimport.pl -file /path/to/marc.iso2709
288     Authority data in MARC21 format
289     $ misc/migration_tools/bulkauthimport.pl -file /path/to/auth.iso2709
290
291 7.2 Fast Index:
292     $ misc/migration_tools/rebuild_zebra.pl -b -w
293
294     Once the indexing has completed, you will be able to search for records in your system.
295     NOTE: This script should be run as the kohauser (the default is 'koha').
296
297 7.3 Schedule regular index updates
298
299     You need to run rebuild_zebra.pl -b -a -z as a regular cron job in orde to pick up new bibs
300     and items as you add them. Check misc/cronjobs/crontab.example for usage examples. See 7.0 above.
301     NOTE: This job should be setup under the kohauser (the default is 'koha').
302
303     You can also indexing in background, see 5.2.2 above
304
305 7.4 To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
306     change the <listen> options to listen on a TCP port; then restart the zebra daemon.
307
308 UPGRADE
309 =======
310 If you are running in another language other than english, please
311 switch to english before doing the upgrade, the templating system has
312 changed and the templates will need to be regenerated.
313 Once you have upgraded, please regenerate your templates in your
314 chosen languages.
315
316 If you are upgrading from a previous installation of Koha 3.x, you can
317 use the following:
318
319  ./koha_perl_deps.pl -u -m # to identify new Perl dependencies
320
321 Install any missing modules
322 IMPORTANT: Koha 3.6.x uses Template::Toolkit, this must be installed
323 before the webinstaller can run
324
325  sudo apt-get install libtemplate-perl
326
327 Koha 3.4.x or later no longer stores items in biblio records so
328 if you are upgrading from an older version as part of the
329 upgrade you will need to do the following two steps, they can take a
330 long time (several hours) to complete for large databases
331
332  misc/maintenance/remove_items_from_biblioitems.pl --run
333  misc/migration_tools/rebuild_zebra.pl -b -r
334
335 Uninstall Instructions
336 =============================
337 1) Stop Services:
338    $ sudo a2dissite koha
339    $ sudo rm /etc/apache2/sites-available/koha
340    $ sudo apache2ctl restart
341
342    $ sudo update-rc.d koha-zebra-daemon remove
343    $ sudo rm /etc/init.d/koha-zebra-daemon
344
345 2) Remove Database and Indexes
346
347    # MySQL
348    $ mysql -u<kohauser> -p<kohapassword>
349    > drop database koha;
350
351    # Zebra Indexes
352    $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
353    $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
354
355 3) Remove Koha Install Directories and Configuration Files
356    Don't forget about any crontab entries
357
358 Tested on the following operating environments
359 ==============================================
360 - Ubuntu Jaunty Jackalope 9.04
361
362 Installer Bug reports
363 =====================
364 Please log any installer bug reports at http://bugs.koha-community.org
365
366 Other Notes
367 =====================
368 This file is part of Koha
369
370 Koha is free software; you can redistribute it and/or modify it under the
371 terms of the GNU General Public License as published by the Free Software
372 Foundation; either version 2 of the License, or (at your option) any later
373 version.
374
375 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
376 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
377 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
378 You should have received a copy of the GNU General Public License along
379 with Koha; if not, write to the Free Software Foundation, Inc.,
380 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.