View | Details | Raw Unified | Return to bug 8478
Collapse All | Expand All

(-)a/INSTALL.ubuntu (-448 lines)
Lines 1-448 Link Here
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: 20 March 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 GD GD::Barcode::UPCE Algorithm::CheckDigits::M43_001 CHI CHI::Driver::Memcached
94
95
Note: you may need to run CPAN initialization if you've not run cpan
96
before:
97
98
    /etc/perl/CPAN/Config.pm initialized.
99
100
    CPAN is the world-wide archive of perl resources. It consists of about
101
    100 sites that all replicate the same contents all around the globe.
102
    Many countries have at least one CPAN site already. The resources
103
    found on CPAN are easily accessible with the CPAN.pm module. If you
104
    want to use CPAN.pm, you have to configure it properly.
105
106
    If you do not want to enter a dialog now, you can answer 'no' to this
107
    question and I'll try to autoconfigure. (Note: you can revisit this
108
    dialog anytime later by typing 'o conf init' at the cpan prompt.)
109
110
    Are you ready for manual configuration? [yes]
111
112
When the configuration is completed CPAN will install the Perl modules.
113
114
2. Configuration of dependencies
115
116
2.1 Update root MySQL password (if dselect didn't do it for you already)
117
118
    $ sudo mysqladmin password <password>
119
120
2.2 Create the Koha database
121
122
    Create the database and user with associated privileges:
123
124
    $ mysqladmin -uroot -p<password> create <kohadatabasename>
125
    $ mysql -uroot -p<password>
126
127
    Welcome to the MySQL monitor.  Commands end with ; or \g.
128
    Your MySQL connection id is 22
129
    Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
130
131
    Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
132
133
    mysql> grant all on <kohadatabasename>.* to '<kohadatabaseuser>'@'localhost' identified by '<kohadatabaseuserpassword>';
134
    Query OK, 0 rows affected (0.00 sec)
135
136
    mysql> flush privileges;
137
    Query OK, 0 rows affected (0.00 sec)
138
139
    mysql> quit
140
141
2.3 Test your SAX Parser and correct where necessary
142
143
    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:
144
145
    $ cd koha
146
    $ misc/sax_parser_print.pl
147
148
    You should see something like::
149
150
    XML::LibXML::SAX::Parser=HASH(0x81fe220)
151
152
    If you're using PurePerl or Expat, you'll need to edit your
153
    ini file, typically located at:
154
155
    /etc/perl/XML/SAX/ParserDetails.ini
156
157
    You will need to move the entire section for '[XML::LibXML::SAX::Parser]' to the bottom of the ini file.
158
159
2.4 Install DBD::mysql Perl module
160
161
In order to handle UTF-8 correctly, Koha requires at least version 4.004
162
of the DBD::mysql Perl module. However, Debian Etch has a stable package
163
only for version 3.0008, so it is necessary to install the module  from CPAN.
164
DBD::mysql's test suite needs to use a MySQL 'test' DB which doesn't exist
165
anymore. So there are two options to install DBD::mysql:
166
167
  (1) install without test suite,
168
  (2) install with test suite requiring a test MySQL DB creation.
169
170
2.4.1 Install without test suite
171
172
Force install DBD::mysql:
173
174
    $ sudo cpan
175
    cpan> force install DBD::mysql
176
177
2.4.2 Create test database in order to install DBD::mysql
178
179
Because of DBD::mysql's test suite, it is necessary to temporarily create a
180
test database and user:
181
182
    $ mysql -uroot -p<password>
183
184
    Create the database and user with associated privileges:
185
186
    Welcome to the MySQL monitor.  Commands end with ; or \g.
187
    Your MySQL connection id is 22
188
    Server version: 5.0.32-Debian_7etch3-log Debian etch distribution
189
190
    Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
191
192
    mysql> create database test;
193
    Query OK, 1 row affected (0.00 sec)
194
195
    mysql> grant all on test.* to 'test'@'localhost' identified by 'test';
196
    Query OK, 0 rows affected (0.00 sec)
197
    (test database, user, and password can be different if need be)
198
199
    mysql> flush privileges;
200
    Query OK, 0 rows affected (0.00 sec)
201
202
    mysql> quit
203
204
Next install DBD::mysql:
205
206
    $ sudo cpan
207
208
    cpan> o conf makepl_arg
209
    (get current value of this CPAN parameter)
210
211
    cpan> o conf makepl_arg "--testdb=test --testuser=test --testpass=test"
212
213
    cpan> install DBD::mysql
214
215
    cpan> o conf makepl_arg ''
216
217
    OR
218
219
    cpan> o conf makepl_arg '<old setting>'
220
221
    (restore this setting so as to not interfere with future CPAN installs).
222
223
224
Finally, remove the test database:
225
226
    $ mysql -uroot -p<password>
227
228
    mysql> drop database test;
229
    Query OK, 1 row affected (0.00 sec)
230
231
    mysql> exit
232
    Bye
233
234
3. Run the Koha installer
235
236
    $ perl Makefile.PL
237
    ( answer questions )
238
    $ make
239
    $ make test
240
    $ sudo make install
241
242
4. Configure and start Apache
243
    $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
244
    (note that the path to koha-httpd.conf may be different depending on your
245
    installation choices)
246
247
Add the following lines to /etc/apache2/ports.conf:
248
249
    Listen 80
250
    Listen 8080
251
252
If not running named virtual hosts (The default koha installation does not use named virtual hosts.), comment out the following line:
253
254
    NameVirtualHost *:80
255
256
Run the following commands:
257
258
    $ sudo a2enmod rewrite deflate
259
    $ sudo a2ensite koha
260
    $ sudo apache2ctl restart
261
262
Note: you may still see the usual Apache default site if your VirtualHost
263
configuration isn't correct.  The command "sudo a2dissite default" may be a
264
quick fix, but may have side-effects.  See the Apache HTTPD manual section on
265
virtual hosts for full instructions.
266
267
5. Configure and start Zebra
268
269
Note: it's recommended that you daemonize the Zebra process and add it to your
270
startup profile. For a non-production test/development installation, running
271
Zebra from the command line can be useful. Pick from the two available options
272
below, or roll your own :-)
273
274
Note: it's also recommended that you create a Koha system user, which you will
275
have specified during the install process. Alternatively, Zebra can be
276
configured to run as the root user.
277
278
To add a user do:
279
280
    $ sudo adduser koha
281
282
Option 1: run the Zebra processes from the command line:
283
284
5.1.1 Zebra Search Server
285
286
This process send responses to search requests sent by Koha or
287
Z39.50/SRU/SRW clients.
288
289
    $ sudo -u ${KOHA_USER} zebrasrv -f /etc/koha/koha-conf.xml
290
    (note that the path to koha-conf.xml may be different depending on your
291
    installation choices)
292
293
Note: the user you run Zebra as will be the only user with write permission
294
      on the Zebra index; in development mode, you may wish to use your
295
      system user.
296
297
5.1.2 Zebra Indexer
298
299
Added/updated/deleted records in Koha MySQL database must be indexed
300
into Zebra. A specific script must be launched each time a bibliographic
301
or an authority record is edited.
302
303
    $ sudo -u ${KOHA_USER} misc/migration_tools/rebuild_zebra -z -b -a
304
    NOTE: This script should be run as the kohauser (the default is 'koha').
305
306
Option 2: run the Zebra process as a daemon, and add to startup process:
307
308
Note that references to $SCRIPT_DIR refer to the directory where
309
Koha's command-line scripts are installed, e.g., /usr/share/koha/bin.
310
311
5.2.1 Zebra Search Server
312
313
    $ sudo ln -s ${SCRIPT_DIR}/koha-zebra-ctl.sh  /etc/init.d/koha-zebra-daemon
314
    (Note: ${SCRIPT_DIR} is /usr/share/koha/bin/ by default in a standard install)
315
    $ sudo update-rc.d koha-zebra-daemon defaults
316
    ( Note: see man chkconfig(8) on other distros )
317
318
    $ sudo ${SCRIPT_DIR}/koha-zebra-ctl.sh start
319
320
5.2.2 Zebra Indexer
321
322
Add an entry in Koha user crontab to scheduled added/updated/deleted records
323
indexing by Zebra with this command:
324
325
  <path/to/koha>/misc/migration_tools/rebuild_zebra -z -b -a
326
327
See check misc/cronjobs/crontab.example for usage examples.
328
NOTE: This job should be setup under the kohauser (the default is 'koha').
329
330
You can also configure zebra-indexing as an background daemon, see http://wiki.koha-community.org/wiki/Background_indexing_with_Zebra
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
    You can also indexing in background, see 5.2.2 above
367
368
7.4 To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
369
    change the <listen> options to listen on a TCP port; then restart the zebra daemon.
370
371
UPGRADE
372
=======
373
If you are running in another language other than english, please
374
switch to english before doing the upgrade, the templating system has
375
changed and the templates will need to be regenerated.
376
Once you have upgraded, please regenerate your templates in your
377
chosen languages.
378
379
If you are upgrading from a previous installation of Koha 3.x, you can
380
use the following:
381
382
 ./koha_perl_deps.pl -u -m # to identify new Perl dependencies
383
384
Install any missing modules
385
IMPORTANT: Koha 3.6.x uses Template::Toolkit, this must be installed
386
before the webinstaller can run
387
388
 sudo apt-get install libtemplate-perl
389
390
 perl Makefile.PL --prev-install-log /path/to/koha-install-log
391
 make
392
 make test
393
 sudo make upgrade
394
395
Koha 3.4.x or later no longer stores items in biblio records so 
396
if you are upgrading from an older version as part of the
397
upgrade you will need to do the following two steps, they can take a
398
long time (several hours) to complete for large databases
399
400
 misc/maintenance/remove_items_from_biblioitems.pl --run
401
 misc/migration_tools/rebuild_zebra.pl -b -r
402
403
Uninstall Instructions
404
=============================
405
1) Stop Services:
406
   $ sudo a2dissite koha
407
   $ sudo rm /etc/apache2/sites-available/koha
408
   $ sudo apache2ctl restart
409
410
   $ sudo update-rc.d koha-zebra-daemon remove
411
   $ sudo rm /etc/init.d/koha-zebra-daemon
412
413
2) Remove Database and Indexes
414
415
   # MySQL
416
   $ mysql -u<kohauser> -p<kohapassword>
417
   > drop database koha;
418
419
   # Zebra Indexes
420
   $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
421
   $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
422
423
3) Remove Koha Install Directories and Configuration Files
424
   Don't forget about any crontab entries
425
426
Tested on the following operating environments
427
==============================================
428
- Ubuntu Jaunty Jackalope 9.04
429
430
Installer Bug reports
431
=====================
432
Please log any installer bug reports at http://bugs.koha-community.org
433
434
Other Notes
435
=====================
436
This file is part of Koha
437
438
Koha is free software; you can redistribute it and/or modify it under the
439
terms of the GNU General Public License as published by the Free Software
440
Foundation; either version 2 of the License, or (at your option) any later
441
version.
442
443
Koha is distributed in the hope that it will be useful, but WITHOUT ANY
444
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
445
A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
446
You should have received a copy of the GNU General Public License along
447
with Koha; if not, write to the Free Software Foundation, Inc.,
448
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
(-)a/INSTALL.ubuntu.precise (-1 / +399 lines)
Line 0 Link Here
0
- 
1
=============================
2
Installation Guide for Installing Koha on Ubuntu Precise Pangolin (12.04 LTS) with MySQL 5.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
                        Tomas Cohen Arazi (tomascohen@gmail.com)
11
12
Feedback/bug reports: Koha Developer's List:
13
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
14
15
This document last modified: 20 July 2012
16
17
Installation Instructions
18
=============================
19
20
Mostof the commands can be performed as a system user with sudo privileges,
21
as indicated or by running the command directly as root.
22
23
1. Prepare System and Install Dependencies
24
25
1.1 Install Ubuntu 12.04 LTS via CD/DVD/USB
26
27
  Download and install Ubuntu from the official site.
28
29
    - Server edition (command-line only): http://www.ubuntu.com/download/server 
30
    - Desktop edition: http://www.ubuntu.com/download/desktop
31
32
1.2 Add koha-stable repository to your apt sources (as root)
33
34
    $ echo "deb http://debian.koha-community.org/koha squeeze main" > /etc/apt/sources.list.d/koha-community.list
35
    $ wget -O- http://debian.koha-community.org/koha/gpg.asc | apt-key add -
36
    $ sudo apt-get update ; sudo apt-get upgrade
37
38
1.3 Install Apache2 and MySQL 5.5
39
40
  If you plan to use a separate server for MySQL skip the last command.
41
42
    $ sudo apt-get install apache2
43
    $ sudo apt-get install mysql-server
44
45
  Note: You will be prompted to set your root password for MySQL.
46
47
1.4 Set up your locale
48
49
  Your locale should be set to UTF-8, as should Apache2 and MySQL 5.5.
50
  This step is VERY IMPORTANT for a UNICODE compliant system. You _MUST_
51
  be sure to set this BEFORE you install Koha.
52
53
    $ sudo update-locale en_US.UTF-8
54
55
  (You have to log out and back in to see locale change reflected in the locale command)
56
57
  You can verify your system local by running the following command:
58
59
    $ locale
60
61
  Please read over the following document carefully for more information:
62
63
    http://wiki.koha-community.org/wiki/Encoding_and_Character_Sets_in_Koha
64
65
1.5 Get Koha
66
67
  1.5.1 Download Koha released tarball
68
69
  You can get the sources from http://download.koha-community.org. Issuing the
70
  following command you can get the latest stable release (recommended):
71
72
  Download Koha:
73
74
    $ mkdir koha_src ; cd koha_src
75
    $ wget http://download.koha-community.org/koha-latest.tar.gz
76
77
  Unpack:
78
79
    $ tar xvzf koha-latest.tar.gz
80
  
81
  1.5.2 Download Koha via Git (optional)
82
83
  Install Git:
84
85
    $ sudo apt-get install git-core
86
87
  Download Koha:
88
89
    $ git clone git://git.koha-community.org/koha.git kohaclone
90
    $ cd kohaclone
91
    $ git checkout -b myinstall origin
92
93
  Note: for more information about Git, please see the Koha Git Usage Guide:
94
95
    http://wiki.koha-community.org/wiki/Version_Control_Using_Git
96
97
1.6 Install additional Ubuntu dependencies
98
99
  Several Koha dependencies have been conveniently packaged and will be installed
100
  issuing the following commands:
101
102
    $ sudo dpkg --set-selections < install_misc/ubuntu.precise.packages
103
    $ sudo apt-get install dselect
104
    $ sudo dselect install
105
106
1.7 Install Perl dependencies that aren't packaged
107
108
  Run the test script to identify missing libraries
109
110
    $ perl koha_perl_deps.pl -m -u
111
112
  This will list whether any Perl dependencies are missing or need a
113
  later version and whether they are required. They can be installed
114
  using the 'cpan' command. For example:
115
116
    $ sudo cpan GD GD::Barcode::UPCE Algorithm::CheckDigits::M43_001
117
118
  Note: you may need to run CPAN initialization if you've not run cpan before.
119
120
121
2. Configuration of dependencies
122
123
2.1 Update root MySQL password (if dselect didn't do it for you already)
124
125
    $ sudo mysqladmin password <password>
126
127
2.2 Create the Koha database
128
129
  Create the database and user with associated privileges:
130
131
    $ mysqladmin -uroot -p<password> create <kohadatabasename>
132
    $ mysql -uroot -p<password>
133
134
      Welcome to the MySQL monitor.  Commands end with ; or \g.
135
      Your MySQL connection id is 42
136
      Server version: 5.5.24-0ubuntu0.12.04.1 (Ubuntu)
137
138
      Copyright (c) 2000, 2011, Oracle and/or its affiliates. All rights reserved.
139
140
      Oracle is a registered trademark of Oracle Corporation and/or its
141
      affiliates. Other names may be trademarks of their respective
142
      owners.
143
144
      Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
145
146
    mysql> GRANT ALL ON <kohadatabasename>.* TO '<kohadatabaseuser>'@'localhost' IDENTIFIED BY '<kohadatabaseuserpassword>';
147
    Query OK, 0 rows affected (0.00 sec)
148
149
    mysql> FLUSH PRIVILEGES;
150
    Query OK, 0 rows affected (0.00 sec)
151
152
    mysql> quit
153
154
2.3 Test your SAX Parser and correct where necessary
155
156
  You must be sure you're using the XML::LibXML SAX parser, not Expat or PurePerl, both of which have outstanding
157
  bugs with pre-composed characters. You can test your SAX parser by running:
158
159
    $ cd koha
160
    $ misc/sax_parser_print.pl
161
162
  If your setup is wrong, the script will output something like this:
163
164
    Koha wants something like:
165
      XML::LibXML::SAX::Parser=HASH(0x81fe220)
166
    You have:
167
      XML::SAX::Expat=HASH(0x1a94e88)
168
    Looks bad, check INSTALL.* documentation.
169
170
  It means you are using Expat (it could also say PurePerl). You'll need to edit your
171
  ini file, located at:
172
173
    /etc/perl/XML/SAX/ParserDetails.ini
174
175
  and move the entire section for '[XML::LibXML::SAX::Parser]' to the bottom of the ini file. Then run 
176
  the script again. The output should look like this:
177
178
    $ misc/sax_parser_print.pl 
179
    Koha wants something like:
180
      XML::LibXML::SAX::Parser=HASH(0x81fe220)
181
    You have:
182
      XML::LibXML::SAX::Parser=HASH(0x16dfee8)
183
    Looks good.
184
    
185
3. Run the Koha installer
186
187
    $ perl Makefile.PL
188
    ( answer questions )
189
    $ make
190
    $ make test
191
    $ sudo make install
192
193
4. Configure and start Apache
194
195
    $ sudo ln -s /etc/koha/koha-httpd.conf /etc/apache2/sites-available/koha
196
197
  Note: the path to koha-httpd.conf may be different depending on your installation choices.
198
199
  Make sure you have this lines in /etc/apache2/ports.conf:
200
201
    Listen 80
202
    Listen 8080
203
204
  Add the missing one.
205
206
  If not running named virtual hosts (The default koha installation does not use named
207
  virtual hosts.), comment out the following line:
208
209
    NameVirtualHost *:80
210
211
  Run the following commands:
212
213
    $ sudo a2enmod rewrite deflate
214
    $ sudo a2ensite koha
215
    $ sudo apache2ctl restart
216
217
  Note: you may still see the usual Apache default site if your VirtualHost
218
  configuration isn't correct.  The command "sudo a2dissite default" may be a
219
  quick fix, but may have side-effects.  See the Apache HTTPD manual section on
220
  virtual hosts for full instructions.
221
222
5. Configure and start Zebra
223
224
  This process send responses to search requests sent by Koha or Z39.50/SRU/SRW clients.
225
  
226
  Note: the user you run Zebra as will be the only user with write permission on the
227
  Zebra index; in development mode, you may wish to use your system user.
228
229
230
5.1 Zebra Search Server
231
232
  Add a user for running zebra
233
  
234
    $ sudo adduser koha
235
  
236
  Set the zebra daemon to run on start:
237
238
    $ sudo ln -s /usr/share/koha/bin/koha-zebra-ctl.sh /etc/init.d/koha-zebra-daemon
239
    $ sudo update-rc.d koha-zebra-daemon defaults
240
    $ sudo /etc/init.d/koha-zebra-daemon start
241
242
  Note: change the path to koha-zebra-ctl.sh to match your setup if not using the default.
243
244
5.2 Zebra Indexer
245
246
  Add an entry in Koha user crontab to scheduled added/updated/deleted records
247
  indexing by Zebra with this command:
248
249
    <path/to/koha>/misc/migration_tools/rebuild_zebra -z -b -a
250
251
  See check misc/cronjobs/crontab.example for usage examples.
252
253
  Note: This job should be setup under the kohauser (the default is 'koha').
254
255
  You can also configure zebra-indexing as an background daemon, see 
256
  http://wiki.koha-community.org/wiki/Background_indexing_with_Zebra
257
258
6. Run the Web Installer, populate the database, initial configuration of settings
259
260
  Point your browser to http://<servername>:8080/
261
262
  It should redirect you to the Web Installer where you can continue the setup.
263
  You can install the sample data for libraries, patrons, etc. via the Web Installer
264
265
7. Install additional languages
266
267
  In your install directory you can run this commands to have your Koha setup translated
268
  to your language:
269
270
  Set your environment variables:
271
272
    $ export KOHA_CONF=/etc/koha/sites/koha/koha-conf.xml
273
    $ export PERL5LIB=/usr/share/koha/lib/
274
275
  Run the translator script:
276
277
    $ cd /usr/share/koha/misc/translator
278
    $ perl translate install <language-code>
279
280
  <language-code> must be one of the included in the misc/translator/po directory.
281
282
  Note: You can add as many languages as you need. In order to use them you will have
283
  to enable them first in the 'I18N/L10N' section of the Koha preferences.
284
285
8. What next?
286
287
  Once the installer has completed, you can import and index MARC records from the
288
  command line thusly (Note: you can also use the 'Stage MARC records for import' from
289
  the Tools area of Koha's Staff Client to import a batch of MARC records):
290
291
  $ export KOHA_CONF=/usr/share/koha/etc/koha-conf.xml
292
293
  Note: use the correct path to your koha-conf.xml
294
295
8.1 Import
296
297
  Bibliographic data in MARC21 format:
298
    $ misc/migration_tools/bulkmarcimport.pl -file /path/to/marc.iso2709
299
300
  Authority data in MARC21 format:
301
    $ misc/migration_tools/bulkauthimport.pl -file /path/to/auth.iso2709
302
303
8.2 Fast Index:
304
305
    $ misc/migration_tools/rebuild_zebra.pl -b -w
306
307
  Once the indexing has completed, you will be able to search for records in your system.
308
  Note: This script should be run as the kohauser (the default is 'koha').
309
310
8.3 Public Z39.50/SRU server
311
312
  To enable public Z39.50/SRU servers, you'll need to edit your koha-conf.xml and
313
  change the <listen> options to listen on a TCP port; then restart the zebra daemon.
314
315
UPGRADE
316
=======
317
318
  If you are running in another language other than english, please
319
  switch to english before doing the upgrade, the templating system has
320
  changed and the templates will need to be regenerated.
321
  Once you have upgraded, please regenerate your templates in your
322
  chosen languages.
323
324
1. Install new Perl dependencies
325
326
  If you are upgrading from a previous installation of Koha 3.x, you can
327
  use the following to identify new Perl dependencies:
328
329
    $ ./koha_perl_deps.pl -u -m
330
331
  Install any missing modules using the instructions on sections 1.6 and 1.7.
332
333
2. Upgrade Koha
334
335
    $ perl Makefile.PL --prev-install-log /path/to/koha-install-log
336
    $ make
337
    $ make test
338
    $ sudo make upgrade
339
340
3. Pre-3.4 upgrades
341
342
  Koha 3.4.x or later no longer stores items in biblio records so 
343
  if you are upgrading from an older version as part of the
344
  upgrade you will need to do the following two steps, they can take a
345
  long time (several hours) to complete for large databases:
346
347
    $ misc/maintenance/remove_items_from_biblioitems.pl --run
348
    $ misc/migration_tools/rebuild_zebra.pl -b -r
349
350
Uninstall Instructions
351
=============================
352
353
1. Stop Services:
354
355
   $ sudo a2dissite koha
356
   $ sudo rm /etc/apache2/sites-available/koha
357
   $ sudo apache2ctl restart
358
359
   $ sudo update-rc.d koha-zebra-daemon remove
360
   $ sudo rm /etc/init.d/koha-zebra-daemon
361
362
. Remove Database and Indexes
363
364
   # MySQL
365
   $ mysql -u<kohauser> -p<kohapassword>
366
   > drop database koha;
367
368
   # Zebra Indexes
369
   $ zebraidx -c <prefix>/etc/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
370
   $ zebraidx -c <prefix>/etc/zebradb/zebra-authorities.cfg -g iso2709 -d authorities init
371
372
3. Remove Koha Install Directories and Configuration Files
373
   Don't forget about any crontab entries
374
375
Tested on the following operating environments
376
==============================================
377
378
  - Ubuntu Precise Pangolin 12.04
379
380
Installer Bug reports
381
=====================
382
383
  Please log any installer bug reports at http://bugs.koha-community.org
384
385
Other Notes
386
=====================
387
This file is part of Koha
388
389
Koha is free software; you can redistribute it and/or modify it under the
390
terms of the GNU General Public License as published by the Free Software
391
Foundation; either version 2 of the License, or (at your option) any later
392
version.
393
394
Koha is distributed in the hope that it will be useful, but WITHOUT ANY
395
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
396
A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
397
You should have received a copy of the GNU General Public License along
398
with Koha; if not, write to the Free Software Foundation, Inc.,
399
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Return to bug 8478